Billing Schedules
Get billing schedule payment settings
Get payment settings for billing schedules. Invoices for billing schedules with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Billing schedule payment settings override customer payment settings. You can also override billing schedule payment settings with invoice payment settings.
GET
/
payments
/
settings
/
billing-schedules
/
{id}
Headers
Authorization
string
requiredYour 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
requiredUnique settings ID
Response
200 - application/json
id
string
requiredUnique payment provider ID.
sequenceAccountId
string
requiredUnique Sequence Account ID.
billingScheduleId
string
requiredUnique payment provider ID.
paymentProvider
enum<string>
requiredPayment provider
Available options:
STRIPE
, NONE
autoCharge
boolean
requiredAutomatically collect payments if payment details are available