Sign in
Billing payment method setup

Get a billing payment method setup

Get the state of a billing payment method setup

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses write_payment_method

OAuth Scopes

ResourceScopes
Organizationwrite_payment_method
get/organizations/{organization}/billing/payment-method-setups/{id}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

idstring required

Billing payment method setup ID from update_payment_method. Example: pmsetup_1234.

Response

Returns the billing payment method setup

type'BillingPaymentMethodSetup' required

The resource type

idstring required

The billing payment method setup ID

state'pending' | 'completed' | 'failed' | 'expired' required

The setup state

checkout_urlstring nullable required

The hosted checkout URL while the setup is pending

errorstring nullable required

The failure message when the setup failed

expires_atstring nullable required

When the pending setup expires

completed_atstring nullable required

When the setup completed

failed_atstring nullable required

When the setup failed

Changes

Changed in 1 of the 24 revisions of this API.1