Skip to main content
A subscription payment (spm_*) is one payment a subscription owes. Each charge attempt for it is a card payment. To learn more, see Charge on a schedule.

Example

GET /subscriptions/{subscriptionId}/payments/{subscriptionPaymentId}
The object is everything inside data. The field names below are relative to it: attributes.paymentNumber is data.attributes.paymentNumber in the response.

Fields

string
required
Subscription payment ID (spm_*).
string
required
Resource type. Always subscriptionPayment.
object
required
The payment’s details.
object
required
Objects linked to the payment.

Statuses

Events

This resource sends no webhook events.

Errors

See the error codes these endpoints return.

Sandbox simulations

  • Card fixtures: Test successful payments, declines, 3-D Secure, subscriptions, settlement, cancels, and refunds in Sandbox