Add line once

This endpoint allows you to add a new one-time line item in a subscription contract.

Token scope - Read & write subscription contracts

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

Path param explained :

  • subscriptionId Id of the subscription. This can be passed in the following format :
    • {id} - where id is the Loop internal id of the subscription contract. This is the default path param format.
    • loop-{id} - where id is the Loop internal id of the subscription contract.
    • shopify-${id} - Where id is the shopifySubscriptionId of the subscription contract.
Path Params
int32
required

The unique identifier of the subscription in Loop.

Body Params
int64
required

Shopify variant ID to add as a one-time line item.

int32
required

Quantity of the variant.

string
enum
required

Type of discount applied on the line item.

Allowed:
float
required

Discount value based on the selected discount type.

boolean

Marks the line item as an upsell for analytics tracking.

customAttributes
array of objects

Custom metadata for the line item.

customAttributes
string

This key allows you to add line in a future order of the subscription contract. This feature is limited access only.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json