Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Subscriptions

Create a Subscription

Create a Subscription to charge a Payment Instrument on a recurring schedule. Without a trial period, the first Transfer is created within 60 minutes of the Subscription being created.

Optional features:

  • Trial period - include trial_details to delay the first charge; first_charge_at in the response shows when billing begins. If the Subscription is based on a Subscription Plan, trial_details do not override those from the plan.
  • Discount phase - include discount_phase_details with a reduced amount and a billing_interval_count to apply a discounted price for a set number of cycles before full billing resumes. If the Subscription is based on a Subscription Plan, discount_phase_details do not override the plan's values.
  • Subscription Plan - provide a subscription_plan_id to base the Subscription on a Subscription Plan template (inherits amount, billing_interval, and more). You cannot set the amount field when you use a Subscription Plan.
  • Future start - set start_subscription_at to a future timestamp; the Subscription starts in state NOT_STARTED with subscription_phase: NONE.
  • Billing cycle day - set billing_cycle_day to control which day of the month billing occurs for monthly-cycle subscriptions (e.g., MONTHLY, BIMONTHLY, QUARTERLY, SEMIYEARLY, YEARLY, BIYEARLY, TRIYEARLY). If the start date doesn't match the billing cycle day, the first invoice is prorated.
  • Fixed length - set total_billing_intervals to expire the Subscription after a fixed number of billing cycles.

{% admonition type="info" %} When the Payment Instrument › type is PAYMENT_CARD, APPLE_PAY, or GOOGLE_PAY, Finix runs a $0.01 Authorization to validate the card (AVS and CVV). If validation fails, the API returns 422 and the Subscription is not created. {% /admonition %}

post/subscriptions

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "amount": 5000,
  "billing_interval": "MONTHLY",
  "buyer_details": {
    "identity_id": "IDtEnKsZyJNUGK83ZTx4C45S",
    "instrument_id": "PImXAVgkKVshKWWHUk4xXbve"
  },
  "linked_to": "MUcgYZswyRfqSSbvMsxuaHxZ",
  "linked_type": "MERCHANT",
  "subscription_details": {
    "collection_method": "BILL_AUTOMATICALLY"
  }
}

Response

Subscription

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

application_idstring

The ID of the Application associated with the Subscription.

billing_cycle_dayinteger nullable

The day of the month on which the Subscription is billed. Only applies to subscriptions with a monthly billing cycle (e.g., MONTHLY, BIMONTHLY, QUARTERLY, SEMIYEARLY, YEARLY, BIYEARLY, TRIYEARLY).

If the specified day doesn't exist in a given month (e.g., April 31), the subscription is billed on the last valid day of that month.

Accepted values are 1 to 31.

billing_interval'BIMONTHLY' | 'BIWEEKLY' | 'BIYEARLY' | 'DAILY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIYEARLY' | 'TRIYEARLY' | 'WEEKLY' | 'YEARLY'

How often the buyer is billed. The possible billing intervals are as follows:

  • BIMONTHLY: every 2 months
  • BIWEEKLY: every 2 weeks
  • BIYEARLY: every 2 years
  • DAILY: every day
  • MONTHLY: every month
  • QUARTERLY: each quarter
  • SEMIYEARLY: twice a year
  • TRIYEARLY: every 3 years
  • WEEKLY: every week
  • YEARLY: every year
canceled_via'MERCHANT' | 'AUTOMATED_OVERDUE' | 'SUPPORT' nullable

If the subscription was canceled, this field shows how the cancellation was initiated.

Possible values:

  • MERCHANT - The customer (merchant) canceled the subscription themselves. The linked_to field indicates the related Merchant.
  • AUTOMATED_OVERDUE - The subscription was canceled by the overdue system.
  • SUPPORT - The subscription was canceled by Finix Support.
currency'USD' | 'CAD'

ISO 4217 3-letter currency code.

expires_atstring date-time

The date-time that the Subscription expires if total_billing_intervals is set for the Subscription.

first_charge_atstring date-time

Timestamp when the first Transfer will occur.

linked_tostring

The ID of the Merchant resource that you wish to link to the Subscription (i.e., the merchant that the subscription belongs to).

At this time, only approved merchants with one of the following processors are valid:

  • DUMMY_V1
  • FINIX_V1
linked_type'MERCHANT'

The type of the resource that is specified in the linked_to field.

nicknamestring

A human-readable name for the resource.

start_subscription_atstring date-time

Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing.

state'ACTIVE' | 'CANCELED' | 'EXPIRED' | 'NOT_STARTED' | 'PAST_DUE'

The state of the Subscription.

  • The NOT_STARTED state occurs when the subscription has not yet started, typically indicated by a start_subscription_at timestamp set during creation.
  • A subscription in the PAST_DUE state is unpaid but has not yet been canceled.
subscription_link_idstring nullable

The ID of the Subscription Link that created the Subscription.

subscription_phase'EVERGREEN' | 'DISCOUNT' | 'FIXED' | 'NONE' | 'TRIAL'

Indicates the period within a subscription where specific rules apply.

  • EVERGREEN - The buyer is billed continuously for the subscription until the subscription is canceled.
  • DISCOUNT - The buyer receives a discounted price for a limited billing interval, after which the customer is charged the full subscription amount.
  • FIXED state - Applicable to fixed-length subscriptions.
  • NONE - Indicates that when the start_subscription_at timestamp is set during subscription creation, the subscription is not yet in any phase, and billing has not started.
  • TRIAL - The period during which the buyer is not billed; after this phase, the buyer will begin being billed.
subscription_plan_idstring

The ID of a Subscription Plan from which this Subscription was created. When provided, the plan's amount, billing_interval, and other defaults are inherited.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
total_billing_intervalsinteger

The total number of billing intervals for the Subscription. This represents the total count of recurring billing cycles, such as months or weeks, depending on the billing frequency.

Example response

{
  "amount": 5000,
  "billing_cycle_day": 1,
  "billing_interval": "MONTHLY",
  "subscription_plan_id": "subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"
}