Create subscription

post

https://api.loopsubscriptions.com/admin/2023-10/subscription

Token scope - Read & write subscription contracts

Rate limit - Global pool (i.e. 50 requests per second per domain)

Note: If nextBillingDateEpoch is within 24 hours of the time the Create Subscription API is called, the first order will be shifted to the next billing cycle instead of being created at the specified date/time. To avoid this, ensure that nextBillingDateEpoch is passed at least 24 hours in the future from the time the API is called.

Body Params

customerShopifyId

int64

required

The unique identifier of the customer in Shopify

nextBillingDateEpoch

int32

required

Next billing date (in epoch seconds) of the subscription.

currencyCode

string

required

Currency code of the subscription

paymentMethodId

int32

required

ID of the payment method of the customer

billingPolicy

object

required

Defines when the customer is billed, including interval (e.g., monthly, yearly), interval count, min and max cycle for billing.

deliveryPolicy

object

required

Specifies how often deliveries occur, including delivery interval and interval count (e.g., every 2 weeks, monthly).

lines

array of objects

required

Specifies list of variants to be included in the subscription, each with their variantShopifyId

lines*

shippingAddress

object

The address where subscription orders will be delivered, including name, street, city, zip code, and country/province codes.It is required if at least one item in the order is a physical product that requires shipping.

originOrderShopifyId

int64

The Shopify order ID from which the subscription originated, used to link the subscription back to the original purchase.

discountCode

string

manualDiscount

object

Apply manual discount on a subscription contract

customAttributes

array of objects

Add subscription attributes while creating subscription

customAttributes

paymentMethodShopifyId

string

Unique identifier of payment method id in Shopify.

Response

200200