Skip to main content
PUT
Update customer payment gateway connection by external ID

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

payment_gateway_connection_id
string
required
external_customer_id
string | null
required

Body

application/json
provider_customer_id
string | null

The ID of the customer in the external payment provider. Omit it to keep the current one; null clears it, and Orb creates a Stripe customer at the next payment through this connection.

Minimum string length: 1
is_default
enum<boolean> | null

Only true is accepted: it makes this the customer's default mapping for the connection's billing entity. Omit it to keep the current default. To move the default, set it on another mapping.

Available options:
true

Response

OK

A customer's mapping to one payment gateway connection.

payment_gateway_connection_id
string
required

The ID of the payment gateway connection the customer is mapped to.

provider_type
enum<string>
required

The external payment provider of the connection.

Available options:
stripe,
adyen
external_account_id
string | null
required

The ID of the account in the external payment provider.

provider_customer_id
string | null
required

The ID of the customer in the external payment provider, or null if none is set.

billing_entity_id
string
required

The ID of the billing entity that collects payments through the connection.

is_default
boolean
required

Whether Orb charges the customer for that billing entity's invoices through this mapping. On the default billing entity, it is the mapping the customer's payment_provider_id reflects.

created_at
string<date-time>
required

The time the mapping was created.