SMsmokeball
Subscription Payments

Add payment method

Adds a new payment method to the account and sets it for the specified subscription

Important notes:

  • Can optionally set as default payment method for the entire account, or the specified subscription
  • Can force immediate charge for overdue invoices for the specified subscription
  • Payment information format depends on payment system
  • For a usage subscription that doesn't exist yet, the payment method is kept and set as its default when it is created
post/subscriptions/{subscriptionId}/paymentmethods

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/{subscriptionId}/paymentmethods
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

subscriptionIdstring required

The unique identifier of the subscription

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

Changes

No recorded changes to this operation across all 15 revisions of this API.