Create subscription

post https://api.loopsubscriptions.com/api/external/v1/subscription-contracts/create

Create subscription can be used to create a subscription for a specific customer, given a payment method id valid for recurring payments. Rate limit: 10/ sec

❗️
These docs are for a deprecated API version. Visit here to refer the latest API docs.

Body Params

customer_id

string

required

The Shopify customer id for which the subscription contract needs to be created. Example: 12345567899

next_billing_date

string

required

The next billing date (in ISO 8601 format) for the subscription contract. Example: “2014-09-08T08:02:17-05:00”

currency_code

string

required

The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes, and non-standard codes. Example: USD

status

string

required

The current status of the subscription contract. Values include: ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED

payment_method_id

string

required

The Shopify ID associated with the payment method of the customer. Example: 088811c2ede53a7f9ba56b66de6ce302

billing_interval

string

required

The kind of BILLING interval that is associated with this schedule (e.g. Monthly, Weekly, etc). Values: DAY, WEEK, MONTH, YEAR

billing_interval_count

int32

required

The number of billing intervals between invoices. Example: 1

billing_min_cycles

int32

Minimum amount of cycles required in the subscription. Can be null for 0 minimum cycles. Example: 1

billing_max_cycles

int32

Maximum amount of cycles required in the subscription. Can be null for infinite cycles. Example: 5

delivery_interval

string

The kind of DELIVERY interval that is associated with this schedule (e.g. Monthly, Weekly, etc). Values: DAY, WEEK, MONTH, YEAR

delivery_interval_count

int32

The number of delivery intervals between invoices. Example: 1

delivery_price

float

required

The shipping price for each renewal/order of the subscription contract as per the currency specified. Example: 1.5

shipping_address

object

The address to which the subscription will be shipped. Can be null.

lines

array of objects

required

This is an array containing the products that need to be added to the subscription.

lines*

origin_order_shopify_id

string

The Shopify id of the origin order eg: 1324567543

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --location --request POST 'https://api.loopsubscriptions.com/api/external/v1/subscription-contracts/create' \
2
--header 'Content-Type: application/json' \
3
--header 'X-Loop-Token: wWzHlO9PiBNlM9swO2PrfXpUF5MvjWbUoEmUrmHPfLMNz43C74zD2A7tu34AjX9j' \
4
--data '{"customer_id": "5829549195429", "next_billing_date": "2022-01-12", "currency_code": "EUR", "status": "ACTIVE", "payment_method_id": "088811c2ede53a7f9ba56b66de6ce302", "billing_interval": "YEAR", "billing_interval_count": 1, "billing_min_cycles": 1, "billing_max_cycles": 3, "delivery_interval": "YEAR", "delivery_interval_count": 1, "delivery_price": 1, "shipping_address" : { "first_name": null, "last_name": "null", "phone": null, "company": null, "address1": "null", "address2": null, "city": "pune", "zip": "411002", "country": null, "province": null, "province_code": "MH", "country_code": "IN"}, "lines": [{ "variant_id": "40870089818277", "quantity": 1, "current_price": 12 }] }'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

❗️These docs are for a deprecated API version. Visit here to refer the latest API docs.

200200

400400

❗️
These docs are for a deprecated API version. Visit here to refer the latest API docs.