Skip to main content

Documentation

Subscription

Periodic collection transactions without further input from the client or customer.

A payment subscription contains one or more subscription items that are billed as defined in the subscription. It is relevant to products that are defined as services. After the subscription is created, you can add or remove subscription items as required.

Note

  • A customer can have more than one subscription.

  • Subscriptions support card and bank redirect payment method types.

  • To create a subscription with a fixed number of billing periods, such as for an installment sale, you must use Update Subscription during the last billing period and set cancel_at_period_end to true.

Prerequisites

  • A subscription requires one or more active plans. See Create Plan.

  • Each plan requires a product of type service. See Create Product.

Subscription Methods

Subscription Webhooks

Subscription Error Messages