Skip to main content
GET
Get billing schedule payment settings by billing schedule ID

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Unique billing schedule ID

Response

OK

id
string
required

Unique payment provider ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

sequenceAccountId
string
required

Unique Sequence Account ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

billingScheduleId
string
required

Unique payment provider ID.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

paymentProvider
enum<string>
required

Payment provider

Available options:
STRIPE,
GOCARDLESS,
NONE
Example:

"STRIPE"

autoCharge
boolean
required

Automatically collect payments if payment details are available

Example:

true