Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscription Payments

Add payment method

Adds a new payment method to the account.

Important notes:

  • Can optionally set as default payment method for the entire account
  • Can force immediate charge for overdue invoices for all active subscriptions
  • Payment information format depends on payment system
post/subscriptions/paymentmethods

Request body

paymentSystemIdstring nullable

Payment system to use.

paymentInformationPaymentInformation

Base class for payment information.

isDefaultboolean nullable

Whether to set this as the default payment method for the entire account

This does not set the default payment method for the subscription.

chargeImmediatelyboolean nullable

Whether to charge immediately if subscription(s) are overdue.

If true, the payment system will attempt to charge the customer immediately if there are any overdue subscriptions.

If a subscription id is passed as a parameter to the request, only that subscription will be charged immediately if overdue.

Example request

{
  "paymentSystemId": "STRIPE",
  "isDefault": true,
  "chargeImmediately": true
}

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable