Create Subscription

Create a subscription for regular, automatic payments.

This method triggers the Customer Subscription Created webhook. This webhook contains the same information as the response.

The following asynchronous webhooks provide information about later changes to the subscription:

Depending on the parameters in the request, some of these webhooks are triggered synchronously.

Note

Clients with PCI certification can handle personal identifying information for cards. Clients that are not PCI-certified can use Checkout Page or Payment Link to collect money from a card.
Before you create a subscription with a payment method token, verify that the value of is_tokenizable is true. See also Payment Method Type.
If the payment method category is card, certain operations require 3DS authentication. To simulate this authentication in the sandbox, use the URL from the redirect_url field that appears in Invoice Payment Created Webhook and Payment Succeeded Webhook. See Simulating 3DS Authentication.
A card payment that requires 3DS authentication must be authenticated within 15 minutes.
All plans in the subscription must have the same value for trial_period_days.

Parameters

Request Header Parameters

Request Body Parameters

- billing
- Determines the method of billing at the end of the billing cycle. Set to pay_automatically - Rapyd generates a payment object, then attempts to pay it using the designated payment method.
- billing_cycle_anchor
- Determines the start of the next full billing cycle, as defined in the plan described in the items. Value:
  - Timestamp in Unix time - Number (integer). A time in the future, at or after the end of the free trial period, not more than the length of the billing cycle. The current billing cycle will be shorter than all other billing cycles.
  Note
  If you update trial_end, billing_cycle_anchor is reset to the end of the new trial period.
- cancel_at_period_end
- Determines the last date that charges accrue.
  - true - Charges accrue until the end of the current billing period, then the subscription is canceled.
    When no trial period is set, after cancel_at_period_end is set to true the subscription will not be renewed at the next interval.
    When a trial period is set after cancel_at_period_end is set to true, the subscription will not begin.
  - false - When the subscription is created, no end is defined. When Cancel Subscription is run, charges stop immediately and the subscription is canceled.
  false
- coupon
- ID of a coupon to apply a discount to the subscription. If the coupon defines a fixed monetary discount, it must use the same currency as the subscription. String starting with coupon_.
- customer
- ID of the customer who pays for this subscription. String starting with cus_.
- days_until_due
- Number of days from the invoice date for customer to complete the payment.
- metadata
- A JSON object defined by the client. See Metadata.
- payment_fields
- Additional payment_options fields.
- payment_method
- Payment method ID or payment_method object. See Add Payment Method to Customer. If not specified in this field, the payment method is the default payment method specified for the customer. To create a payment method ID, use Add Payment Method to Customer or Create Card Token. The ID is a string starting with card_ or other_.
- simultaneous_invoice
- Determines whether each upcoming subscription invoice is issued immediately.
  - true - The invoice is issued when the subscription is created.
  - false - The invoice is issued an hour after the subscription is created.
  true
- subscription_items
- In requests, an array of objects containing the following fields. All subscription items must have plans with identical values for interval and interval_count.
  - plan
    ID of a plan that describes the service and pricing structure. The plan must be active.
  - quantity
    Number of units of the service described in plan. Integer.
- tax_percent
- The percentage tax rate that is applied to the subtotal of the invoice, after subtracting all discounts. Decimal. Range: 0-100, with up to four decimal places.
- trial_end
- Defines the customer's free trial period. Relevant when trial_period_days is not defined. One of the following values:
  - The date and time of the end of the free trial period, in Unix time. Number (integer),
  - now - There is no free trial period.
- trial_from_plan
- Determines whether the subscription uses the free trial period defined in the plan.
  - true - Uses the trial period defined in the plans added to the subscription. When trial_from_plan is true, all plans in the subscription must have the same value for trial_period_days.
  - false - Uses the trial period defined in the subscription.
  false
- trial_period_days
- The number of days in the customer's free trial period. Integer. Range: 0-730.
  Relevant when trial_end is not defined.

Response Parameters

- billing
- Determines the method of billing at the end of the billing cycle. Set to pay_automatically - Rapyd generates a payment object, then attempts to pay it using the designated payment method.
- billing_cycle_anchor
- Determines the start of the next full billing cycle, as defined in the plan described in the items. One of the following values:
  now - The present day. The next billing cycle starts right now.
  Timestamp in Unix time - A time in the future, at or after the end of the free trial period, not more than the length of the billing cycle. The current billing cycle will be shorter than all other billing cycles. Relevant to creating a subscription.
  unchanged - The original billing cycle anchor is unchanged. Relevant to updating a subscription.
- cancel_at_period_end
- Determines the last date that charges accrue.
  true - Charges accrue until the end of the current billing period, then the subscription is canceled.
  When no trial period is set, after cancel_at_period_end is set to true the subscription will not be renewed at the next interval.
  When a trial period is set after cancel_at_period_end is set to true, the subscription will not begin.
  false - When the subscription is created, no end is defined. When Cancel Subscription is run, charges stop immediately and the subscription is canceled.
- cancel_checkout_url
- URL where the customer is redirected after pressing Back to Website to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs.
- canceled_at
- Date and time that the subscription is canceled by the customer or by the client. Unix time.
- complete_checkout_url
- URL where the customer is redirected after pressing Finish to exit the hosted page. This URL overrides the merchant_website URL. Does not support localhost URLs.
- complete_payment_url
- URL where the customer is redirected when payment is successful, after returning from an external page such as a 3DS page. Does not support localhost URLs.
- coupon
- ID of a coupon to apply a discount to the subscription. String starting with coupon_.
- created_at
- Time of creation of this subscription, in Unix time.
- current_period_end
- End of the current billing cycle, in Unix time.
- current_period_start
- Start of the current billing cycle, in Unix time.
- customer_token
- ID of the customer who pays for this subscription. String starting with cus_.
- days_until_due
- Number of days the customer has for paying this invoice.
- discount
- Contains information about the coupon that applies to the subscription. Returned as a null value when there is no discount.
- ended_at
- Date that the subscription was canceled or otherwise terminated. Unix time.
- error_payment_url
- URL where the customer is redirected when payment is not successful, after returning from an external page, such as a 3DS page. Does not support localhost URLs.
- id
- ID of the Subscription object. String starting with sub_.
- language
- Determines the default language of the hosted page. For a list of values, see List Supported Languages.
  When this parameter is null, the language of the user's browser is used.
  If the language of the user's browser cannot be determined, the default language is English.
- merchant_reference_id
- Identifier defined by the client for reference purposes. Limit: 45 characters.
- metadata
- A JSON object defined by the client. See Metadata.
- page_expiration
- End of the time when the customer can use the hosted page, in Unix time. If page_expiration is not set, the hosted page expires 14 days after creation.
  Range: 1 minute to 30 days.
- payment_fields
- Additional payment_options fields.
- payment_method
- Payment method used for paying invoices generated by this subscription. The ID is a string starting with card_ or other_.
- payout_fields
- Reserved.
- product
- ID of a product object. String starting with product_ Relevant to List Subscriptions.
- simultaneous_invoice
- Determines when the system creates a payment for an invoice.
  true - Payment is created when the invoice is issued.
  false - Payment is created one hour after the invoice is issued.
- status
- Status of the subscription. One of the following:
  active - The customer is currently paying for this subscription.
  canceled - The customer has canceled this subscription, but it remains in the Rapyd database.
  past_due - Payment for this subscription was not received by the end of the billing period.
  trialing - The subscription is in its free trial period.
  unpaid - An error occurred in the payment for this subscription.
- subscription_items
- An object or array of objects containing the following fields:
  data
  Array of objects that describe individual subscription items.
  created
  The time the subscription item was created, in Unix time.
  id
  ID of the subscription item. String starting with subi_.
  metadata
  A JSON object defined by the client. See Metadata.
  plan
  The pricing plan that defines the product and pricing structure associated with this subscription item. Cannot be a plan that is already part of the subscription. For details of the fields in the 'plan' object, see Create Plan.
  quantity
  The number of units of the service defined in the plan. Integer. This number can be updated during the billing cycle using Update Subscription or Update Subscription Item.
  subscription_id
  ID of the subscription that this subscription item belongs to. String starting with sub_.
  has_more
  Indicates that the number of subscription_items records is greater than the number of the returned records.
  total_count
  Number of subscription_items records.
  url
  URL for the record of all subscription items for this subscription.
- tax_percent
- The percentage tax rate that is applied to the subtotal of the invoice, after subtracting all discounts. Decimal.
- trial_end
- The date and time of the end of the customer's free trial period, in Unix time, or the string now. Relevant when trial_period_days is not defined.
- trial_from_plan
- Determines whether the subscription uses the free trial period defined in the plan.
  - true - Uses the trial period defined in the plans added to the subscription. When trial_from_plan is true, all plans in the subscription must have the same value for trial_period_days.
  - false - Uses the trial period defined in the subscription.
- trial_period_days
- The number of days in the customer's free trial period. Integer. Range: 0-730.
  Relevant when trial_end is not defined.
- trial_start
- Date and time of the start of the customer's free trial period, in Unix time.
- type
- The type of the subscription.
  - payment

Code Samples

.NET

using System;
using System.Text.Json;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                var requestObj = new
                {
                    customer = "cus_ec543c4dfcf6ac1d015b2e3e4fd07180",
                    billing = "pay_automatically",
                    billing_cycle_anchor = "",
                    cancel_at_period_end = true,
                    coupon = "",
                    days_until_due = string.Empty,
                    payment_method = "card_156da7de485275ad0bae798b7cb8fea1",
                    subscription_items = new Object[] {
                        new {
                            plan = "plan_51788cf4ed1b672cb0a2a97773887f5b",
                            quantity = 1
                        }
                    },
                    metadata = new
                    {
                        merchant_defined = true
                    },
                    tax_percent = 10.5,
                    trial_end = 0,
                    trial_from_plan = true,
                    trial_period_days = string.Empty,
                    plan_token = ""
                };

                string request = JsonSerializer.Serialize(requestObj);

                string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/payments/subscriptions", request);
    
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const body = {
      customer: 'cus_ec543c4dfcf6ac1d015b2e3e4fd07180',
      billing: 'pay_automatically',
      billing_cycle_anchor: '',
      cancel_at_period_end: true,
      coupon: '',
      days_until_due: null,
      payment_method: 'card_156da7de485275ad0bae798b7cb8fea1',
      subscription_items: [
        {
          plan: 'plan_51788cf4ed1b672cb0a2a97773887f5b',
          quantity: 1
        }
      ],
      metadata: {
        merchant_defined: true
      },
      tax_percent: 10.5,
      trial_end: 0,
      trial_from_plan: true,
      trial_period_days: null,
      plan_token: ''
    };
    const result = await makeRequest('POST', '/v1/payments/subscriptions', body);

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $body = [
        "customer" => "cus_ec543c4dfcf6ac1d015b2e3e4fd07180",
        "billing" => "pay_automatically",
        "billing_cycle_anchor" => "",
        "cancel_at_period_end" => true,
        "coupon" => "",
        "days_until_due" => null,
        "payment_method" => "card_156da7de485275ad0bae798b7cb8fea1",
        "subscription_items" => [
            array(
                "plan" => "plan_51788cf4ed1b672cb0a2a97773887f5b",
                "quantity" => 1
            )
        ],
        "metadata" => array(
            "merchant_defined" => true
        ),
        "tax_percent" => 10.5,
        "trial_end" => 0,
        "trial_from_plan" => true,
        "trial_period_days" => null,
        "plan_token" => ""
    ];
    $object = make_request('post', '/v1/payments/subscriptions', $body);
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

subscription = {
    "customer": "cus_ec543c4dfcf6ac1d015b2e3e4fd07180",
    "billing": "pay_automatically",
    "billing_cycle_anchor": "",
    "cancel_at_period_end": True,
    "coupon": "",
    "days_until_due": "",
    "payment_method": "card_156da7de485275ad0bae798b7cb8fea1",
    "subscription_items": [
        {
            "plan": "plan_51788cf4ed1b672cb0a2a97773887f5b",
            "quantity": 1
        }
    ],
    "metadata": {
        "merchant_defined": True
    },
    "tax_percent": 10.5,
    "trial_end": 0,
    "trial_from_plan": True,
    "trial_period_days": "",
    "plan_token": "",
}

result = make_request(method='post', path='/v1/subscriptions', body=subscription)
pprint(result)

/v1/payments/subscriptions

Create Subscription

curl -X post
https://sandboxapi.rapyd.net/v1/payments/subscriptions
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "customer": "cus_b306773fc73d23e5a9b4347984606cf7",
    "billing": "pay_automatically",
    "cancel_at_period_end": true,
    "coupon": "",
    "payment_method": "card_3c000ae5db06762a2c8a00ca514fa336",
    "subscription_items": [
        {
            "plan": "plan_aa8c4248e0f2a8cdc5f2139a8bf38f10",
            "quantity": 1
        }
    ],
    "metadata": {
        "merchant_defined": true
    },
    "tax_percent": 10.5,
    "trial_end": 0,
    "trial_from_plan": true,
    "trial_period_days": null,
    "proration_date":"1699194033"
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "af5d9b80-9d3f-4f2c-9594-5904787ea7fd"
    },
    "data": {
        "id": "sub_e434b29193daa54d384da87c4ef03c46",
        "billing": "pay_automatically",
        "billing_cycle_anchor": 1698589289,
        "created_at": 1698589289,
        "customer_token": "cus_b306773fc73d23e5a9b4347984606cf7",
        "days_until_due": 30,
        "metadata": {
            "merchant_defined": true
        },
        "tax_percent": 10.5,
        "cancel_at_period_end": true,
        "canceled_at": null,
        "current_period_end": 1701267689,
        "current_period_start": 1698589289,
        "discount": null,
        "ended_at": null,
        "subscription_items": {
            "data": [
                {
                    "id": "subi_327bf79d360433c6fc693285ff994d76",
                    "created": 1698589289,
                    "metadata": null,
                    "quantity": 1,
                    "plan": {
                        "id": "plan_aa8c4248e0f2a8cdc5f2139a8bf38f10",
                        "aggregate_usage": "sum",
                        "amount": 0,
                        "billing_scheme": "tiered",
                        "created_at": 1698588009,
                        "currency": "USD",
                        "interval": "month",
                        "interval_count": 1,
                        "metadata": {},
                        "product": "product_af760dadef7c1d4106e2558bcf6799f9",
                        "nickname": "Transit Use",
                        "tiers": [
                            {
                                "amount": 4,
                                "up_to": 5,
                                "flat_amount": 1
                            },
                            {
                                "amount": 3,
                                "up_to": 10,
                                "flat_amount": 0
                            },
                            {
                                "amount": 2,
                                "up_to": 20,
                                "flat_amount": 0
                            },
                            {
                                "amount": 1,
                                "up_to": "inf",
                                "flat_amount": 0
                            }
                        ],
                        "tiers_mode": "graduated",
                        "transform_usage": {
                            "divide_by": 1,
                            "round": "up"
                        },
                        "trial_period_days": 0,
                        "usage_type": "licensed",
                        "active": true
                    }
                }
            ],
            "has_more": false,
            "total_count": 0,
            "url": "/v1/subscription_items?subscription=sub_e434b29193daa54d384da87c4ef03c46"
        },
        "status": "active",
        "trial_end": null,
        "trial_start": null,
        "payment_method": "card_3c000ae5db06762a2c8a00ca514fa336",
        "payment_fields": null,
        "payout_fields": null,
        "type": "payment",
        "simultaneous_invoice": false
    }
}

Create Subscription with Payment Fields

curl -X post
https://sandboxapi.rapyd.net/v1/payments/subscriptions
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "customer": "cus_b306773fc73d23e5a9b4347984606cf7",
    "billing": "pay_automatically",
    "cancel_at_period_end": false,
    "coupon": "",
    "payment_method": {
        "type": "gb_visa_card",
        "fields": {
            "name": "John Doe",
            "number": "4111111111111111",
            "expiration_month": "05",
            "expiration_year": "25",
            "cvv": "111"
        }
    },
    "subscription_items": [
        {
            "plan": "plan_aa8c4248e0f2a8cdc5f2139a8bf38f10",
            "quantity": 1
        }
    ],
    "metadata": {
        "merchant_defined": "true"
    },
    "tax_percent": 10.5,
    "trial_end": 0,
    "trial_from_plan": true,
    "trial_period_days": "",
    "payment_fields": {
        "error_payment_url": "https://error.example1234.net",
        "complete_payment_url": "https://complete.example5678.net"
    }
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "bc404739-8ce9-4d4d-8192-2cc6eca89ddb"
    },
    "data": {
        "id": "sub_aa388923118ab61a65dd73bdfa2bd3cd",
        "billing": "pay_automatically",
        "billing_cycle_anchor": 1700138214,
        "created_at": 1700138214,
        "customer_token": "cus_b306773fc73d23e5a9b4347984606cf7",
        "days_until_due": 30,
        "metadata": {
            "merchant_defined": "true"
        },
        "tax_percent": 10.5,
        "cancel_at_period_end": false,
        "canceled_at": null,
        "current_period_end": 1702730214,
        "current_period_start": 1700138214,
        "discount": null,
        "ended_at": null,
        "subscription_items": {
            "data": [
                {
                    "id": "subi_295deb5d5052a237ecaee9663ea0365d",
                    "created": 1700138214,
                    "metadata": null,
                    "quantity": 1,
                    "plan": {
                        "id": "plan_aa8c4248e0f2a8cdc5f2139a8bf38f10",
                        "aggregate_usage": "sum",
                        "amount": 0,
                        "billing_scheme": "tiered",
                        "created_at": 1698588009,
                        "currency": "USD",
                        "interval": "month",
                        "interval_count": 1,
                        "metadata": {},
                        "product": "product_af760dadef7c1d4106e2558bcf6799f9",
                        "nickname": "Transit Use",
                        "tiers": [
                            {
                                "amount": 4,
                                "up_to": 5,
                                "flat_amount": 1
                            },
                            {
                                "amount": 3,
                                "up_to": 10,
                                "flat_amount": 0
                            },
                            {
                                "amount": 2,
                                "up_to": 20,
                                "flat_amount": 0
                            },
                            {
                                "amount": 1,
                                "up_to": "inf",
                                "flat_amount": 0
                            }
                        ],
                        "tiers_mode": "graduated",
                        "transform_usage": {
                            "divide_by": 1,
                            "round": "up"
                        },
                        "trial_period_days": 0,
                        "usage_type": "licensed",
                        "active": true
                    }
                }
            ],
            "has_more": false,
            "total_count": 0,
            "url": "/v1/subscription_items?subscription=sub_aa388923118ab61a65dd73bdfa2bd3cd"
        },
        "status": "active",
        "trial_end": null,
        "trial_start": null,
        "payment_method": "card_a340e3bb4ea898f4d00aff7f454141be",
        "payment_fields": {
            "error_payment_url": "https://error.example1234.net",
            "complete_payment_url": "https://complete.example5678.net"
        },
        "payout_fields": null,
        "type": "payment",
        "simultaneous_invoice": false
    }
}

Create Subscription with Multiple Items

curl -X post
https://sandboxapi.rapyd.net/v1/payments/subscriptions
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-d '{
    "customer": "cus_b306773fc73d23e5a9b4347984606cf7",
    "billing": "pay_automatically",
    "cancel_at_period_end": false,
    "payment_method": "card_3c000ae5db06762a2c8a00ca514fa336",
    "subscription_items": [
        {
            "plan": "plan_26aabd1d48bcfec1ff05dc2bed772aa3",
            "quantity": 3
        },
        {
            "plan": "plan_4feb4cf48e807cd142d7759a58a55d2f",
            "quantity": 5
        }
    ]
}
'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "a84d8452-181a-4b10-8357-d991ff35ccda"
    },
    "data": {
        "id": "sub_db73da2fc2a7a3b8451fed8afdbaf46c",
        "billing": "pay_automatically",
        "billing_cycle_anchor": 1700140716,
        "created_at": 1700140716,
        "customer_token": "cus_b306773fc73d23e5a9b4347984606cf7",
        "days_until_due": 30,
        "metadata": {},
        "tax_percent": 0,
        "cancel_at_period_end": false,
        "canceled_at": null,
        "current_period_end": 1702732716,
        "current_period_start": 1700140716,
        "discount": null,
        "ended_at": null,
        "subscription_items": {
            "data": [
                {
                    "id": "subi_f0d375617a093d30307adec9ea246b44",
                    "created": 1700140716,
                    "metadata": null,
                    "quantity": 3,
                    "plan": {
                        "id": "plan_26aabd1d48bcfec1ff05dc2bed772aa3",
                        "aggregate_usage": "sum",
                        "amount": 10.99,
                        "billing_scheme": "per_unit",
                        "created_at": 1700140584,
                        "currency": "USD",
                        "interval": "month",
                        "interval_count": 1,
                        "metadata": {},
                        "product": "product_4ba001c7655c4a0ee4f471dbaccaa305",
                        "nickname": "Unlimited Plan plus",
                        "tiers": [],
                        "tiers_mode": "",
                        "transform_usage": {
                            "divide_by": 1,
                            "round": "up"
                        },
                        "trial_period_days": 7,
                        "usage_type": "licensed",
                        "active": true
                    }
                },
                {
                    "id": "subi_e3cec118feec75e0f270d888a053a410",
                    "created": 1700140716,
                    "metadata": null,
                    "quantity": 5,
                    "plan": {
                        "id": "plan_4feb4cf48e807cd142d7759a58a55d2f",
                        "aggregate_usage": "sum",
                        "amount": 9.99,
                        "billing_scheme": "per_unit",
                        "created_at": 1700140529,
                        "currency": "USD",
                        "interval": "month",
                        "interval_count": 1,
                        "metadata": {},
                        "product": "product_4ba001c7655c4a0ee4f471dbaccaa305",
                        "nickname": "Unlimited Plan",
                        "tiers": [],
                        "tiers_mode": "",
                        "transform_usage": {
                            "divide_by": 1,
                            "round": "up"
                        },
                        "trial_period_days": 7,
                        "usage_type": "licensed",
                        "active": true
                    }
                }
            ],
            "has_more": false,
            "total_count": 0,
            "url": "/v1/subscription_items?subscription=sub_db73da2fc2a7a3b8451fed8afdbaf46c"
        },
        "status": "active",
        "trial_end": null,
        "trial_start": null,
        "payment_method": "card_3c000ae5db06762a2c8a00ca514fa336",
        "payment_fields": null,
        "payout_fields": null,
        "type": "payment",
        "simultaneous_invoice": false
    }
}

In this section:

Documentation

Create Subscription

Note

Parameters

Request Header Parameters

Request Body Parameters

Note

Response Parameters

Code Samples

Search results