Bold Subscriptions v2 (1.0)

Download OpenAPI specification:Download

E-mail: partners@boldcommerce.com Terms of Service

Bold Subscriptions customers use our API to interact with subscription data in unique ways. This includes the ability to modify, cancel and report on subscriptions.

Refer to the changelog for the latest updates to this API.

Discover more apps by Bold

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"Access token"

Customers

View and manage customers

List Customers

Retrieve a list of customers.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

query Parameters

status	string Enum: "all" "active" "inactive" Example: status=active Status of customers returned. Multiple statuses can be passed as an array.
search	string Customer text search
limit	integer Maximum number of results to be returned
page	integer The desired page number for the paginated result

Responses

Response samples

Content type

application/json

{"customers": [{"id": 0,
"platform_id": "string",
"cashier_public_id": "string",
"first_name": "John",
"last_name": "Doe",
"phone": "123-456-7890",
"email": "john.doe@example.com",
"notes": "Loyal customer.",
"addresses": [{"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"default_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"subscription_summary": {"bold_platform_customer_id": 0,
"next_order_date": "2020-01-20T18:00:00Z",
"last_order_date": "2019-11-20T20:55:27Z",
"active_subscription_count": 2,
"inactive_subscription_count": 1,
"subscription_order_count": 5
},
"labels": [{"id": 0,
"customer_id": 0,
"name": "bsub_subscription_active",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
]
}
]
}

Get Customer

Retrieve a customer by their id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"customer": {"id": 0,
"platform_id": "string",
"cashier_public_id": "string",
"first_name": "John",
"last_name": "Doe",
"phone": "123-456-7890",
"email": "john.doe@example.com",
"notes": "Loyal customer.",
"addresses": [{"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"default_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"subscription_summary": {"bold_platform_customer_id": 0,
"next_order_date": "2020-01-20T18:00:00Z",
"last_order_date": "2019-11-20T20:55:27Z",
"active_subscription_count": 2,
"inactive_subscription_count": 1,
"subscription_order_count": 5
},
"labels": [{"id": 0,
"customer_id": 0,
"name": "bsub_subscription_active",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
]
}
}

Update Customer

Update a customer by their id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.

Request Body schema: application/json

object (CustomerEntity)

first_name required	string
last_name required	string
phone required	string or null
email required	string
notes required	string or null

Responses

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "John",
"last_name": "Doe",
"phone": "123-456-7890",
"email": "john.doe@example.com",
"notes": "Loyal customer."
}
}

Response samples

Content type

application/json

{"customer": {"id": 0,
"platform_id": "string",
"cashier_public_id": "string",
"first_name": "John",
"last_name": "Doe",
"phone": "123-456-7890",
"email": "john.doe@example.com",
"notes": "Loyal customer.",
"addresses": [{"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"default_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"subscription_summary": {"bold_platform_customer_id": 0,
"next_order_date": "2020-01-20T18:00:00Z",
"last_order_date": "2019-11-20T20:55:27Z",
"active_subscription_count": 2,
"inactive_subscription_count": 1,
"subscription_order_count": 5
},
"labels": [{"id": 0,
"customer_id": 0,
"name": "bsub_subscription_active",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
]
}
}

List Customer Addresses

Retrieve a list of addresses for a customer.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"customer_addresses": [{"shop_identifier": "s0m3sh0ph3r3",
"platform_id": 123,
"platform_customer_id": 1,
"platform_type": "bigcommerce",
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "8005550105",
"street1": "123 Whatever Street",
"street2": "Suite #1",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "A1A 1A1",
"is_default": false,
"address_use": "shipping",
"address_source": "platform",
"created_at": "2021-11-16T16:07:29Z",
"updated_at": "2021-11-16T16:19:41Z",
"id": 123456,
"customer_id": 987654
}
]
}

Create Customer Address

Create an address for a customer.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.

Request Body schema: application/json

object (CustomerAddress)

shop_identifier	string Platform shop identifier, not required for creating/updating addresses.
platform_id	number Platform address identifier, not required for creating/updating addresses.
platform_customer_id	number Platform customer identifier, not required for creating/updating addresses.
platform_type required	string Enum: "bigcommerce" "commercetools" "custom" "shopify" "woocommerce" The e-commerce platform being used by the shop (might also be 'custom' for no specific e-commerce platform).
first_name required	string Customer's first name.
last_name required	string Customer's last name(s).
company	string Customer's company name.
phone	string Customer's phone number.
street1 required	string Customer's street address (street name and number).
street2	string Address complement (suite number, unit number, etc.).
city required	string Customer's city.
province required	string Customer's province or state, as applicable. Can be an empty string in case the address has no state/province.
province_code required	string Customer's province or state code (usually 2 characters), as applicable. Can be an empty string in case the address has no state/province.
country required	string Customer's country name.
country_code required	string Customer's alpha 2 country code, according to ISO 3166-1 (reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
zip required	string Customer's postal code.
is_default required	boolean Defines if this address should be considered the default one for the customer.
id	number Address id inside the subscriptions database (not required for creating/updating addresses).
customer_id	number Customer id inside the subscriptions database (not required for creating/updating addresses).

Responses

Request samples

Payload

Content type

application/json

{"customer_address": {"platform_type": "bigcommerce",
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "8005550105",
"street1": "123 Whatever Street",
"street2": "Suite #1",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "A1A 1A1",
"is_default": false
}
}

Response samples

Content type

application/json

{"customer_address": {"shop_identifier": "s0m3sh0ph3r3",
"platform_id": 123,
"platform_customer_id": 1,
"platform_type": "bigcommerce",
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "8005550105",
"street1": "123 Whatever Street",
"street2": "Suite #1",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "A1A 1A1",
"is_default": false,
"address_use": "shipping",
"address_source": "platform",
"created_at": "2021-11-16T16:07:29Z",
"updated_at": "2021-11-16T16:19:41Z",
"id": 123456,
"customer_id": 987654
}
}

Update Customer Address

Update an address for a customer.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.
address_id required	integer Address ID to view and manage data for.

Request Body schema: application/json

object (CustomerAddress)

shop_identifier	string Platform shop identifier, not required for creating/updating addresses.
platform_id	number Platform address identifier, not required for creating/updating addresses.
platform_customer_id	number Platform customer identifier, not required for creating/updating addresses.
platform_type required	string Enum: "bigcommerce" "commercetools" "custom" "shopify" "woocommerce" The e-commerce platform being used by the shop (might also be 'custom' for no specific e-commerce platform).
first_name required	string Customer's first name.
last_name required	string Customer's last name(s).
company	string Customer's company name.
phone	string Customer's phone number.
street1 required	string Customer's street address (street name and number).
street2	string Address complement (suite number, unit number, etc.).
city required	string Customer's city.
province required	string Customer's province or state, as applicable. Can be an empty string in case the address has no state/province.
province_code required	string Customer's province or state code (usually 2 characters), as applicable. Can be an empty string in case the address has no state/province.
country required	string Customer's country name.
country_code required	string Customer's alpha 2 country code, according to ISO 3166-1 (reference: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
zip required	string Customer's postal code.
is_default required	boolean Defines if this address should be considered the default one for the customer.
id	number Address id inside the subscriptions database (not required for creating/updating addresses).
customer_id	number Customer id inside the subscriptions database (not required for creating/updating addresses).

Responses

Request samples

Payload

Content type

application/json

{"customer_address": {"platform_type": "bigcommerce",
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "8005550105",
"street1": "123 Whatever Street",
"street2": "Suite #1",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "A1A 1A1",
"is_default": false
}
}

Response samples

Content type

application/json

{"customer_address": {"shop_identifier": "s0m3sh0ph3r3",
"platform_id": 123,
"platform_customer_id": 1,
"platform_type": "bigcommerce",
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "8005550105",
"street1": "123 Whatever Street",
"street2": "Suite #1",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "A1A 1A1",
"is_default": false,
"address_use": "shipping",
"address_source": "platform",
"created_at": "2021-11-16T16:07:29Z",
"updated_at": "2021-11-16T16:19:41Z",
"id": 123456,
"customer_id": 987654
}
}

Delete Customer Address

Delete an address from a customer.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.
address_id required	integer Address ID to view and manage data for.

Responses

List Customer Subscriptions

Retrieve a list of subscriptions for a single customer.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
customer_id required	integer Customer ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscriptions": [{"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
],
"pagination": {"count": 2,
"current_page": 1,
"per_page": 10,
"total": 2,
"total_pages": 1
}
}

Shop

Read information on the shop

Get Shop Information

Retrieve basic information about a shop.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Responses

Response samples

Content type

application/json

{"shop": {"id": 1,
"shop_domain": "store-abc123def456.example.com",
"custom_domain": "example-store.example.com",
"shop_identifer": "zya0kzb8hu7ji",
"platform_type": "bigcommerce",
"timezone": "Europe/London",
"currency": "CAD",
"currency_format": "${{amount}}",
"shop_owner": "John Doe",
"admin_email": "john.doe@example.com",
"pii_redacted_at": "2019-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
}

Subscriptions

View and manage subscriptions

List Subscriptions

Retrieve a list of subscriptions.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

query Parameters

subscription_status	any Enum: "active" "inactive" "processing" "scheduled" "paused" Example: subscription_status=active Status of the subscriptions returned. Multiple statuses can be passed as an array.
bold_platform_customer_id	any Example: bold_platform_customer_id=1 Customer Id of the subscriptions returned. Multiple customer ids can be passed as an array.
expand	string Value: "customer" Example: expand=customer Fields to expand on the subscription. Multiple fields can be passed as an array
limit	integer Example: limit=5 Maximum number of results to be returned
filter	string Example: filter=?filter=lt(next_order_datetime:2021-11-15T00:00:00Z)+gt(next_order_datetime:2021-10-31T00:00:00Z) Accepts filtering options as described on the Query & Pagination page. For example, to filter the next order date by a date interval, you could use the following parameter:
cursor	string Example: cursor=?cursor= P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj Returns the next page of results if supplied the `next` value from the previous pagination results.

Responses

Response samples

Content type

application/json

{"subscriptions": [{"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
],
"pagination": {"total": 15,
"count": 10,
"per_page": 10,
"total_pages": 2,
"next": "P3NpbmNlX2lkPTE1Mjc0Jm9yZGVyX2J5PWlkJm9yZGVyX2RpcmVjdGlvbj1kZXNj"
}
}

Create Subscription

For more information about this endpoint, refer to Programmatically Creating Subscriptions.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Request Body schema: application/json

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone": "12045551234",
"notes": "Loyal customer"
},
"subscription": {"idempotency_key": "legacy-id-21425",
"next_order_datetime": "2021-05-21T08:00:00Z",
"last_order_datetime": "2021-04-21T08:00:00Z",
"subscription_status": "active",
"order_rrule": "DTSTART:20210521T080000Z\nRRULE:FREQ=MONTHLY",
"base_currency": "CAD",
"charged_currency": "USD",
"base_to_charged_exchange_rate": 0.79,
"line_items": [{"platform_product_id": "1578934692",
"platform_variant_id": "975285185",
"quantity": 2,
"price": 1000,
"subscription_group_id": 123
}
],
"billing_address": {"first_name": "Jane",
"last_name": "Doe",
"company": "Bold Commerce",
"phone": "12045551234",
"street1": "123 Alphabet St.",
"street2": "101",
"city": "Austin",
"province": "Texas",
"province_code": "TX",
"country": "United States",
"country_code": "US",
"zip": "78701"
},
"shipping_address": {"first_name": "Jane",
"last_name": "Doe",
"company": "Bold Commerce",
"phone": "12045551234",
"street1": "123 Alphabet St.",
"street2": "101",
"city": "Austin",
"province": "Texas",
"province_code": "TX",
"country": "United States",
"country_code": "US",
"zip": "78701"
},
"external_id": "legacy-id-135798642",
"placed_at": "2012-05-21T08:00:00Z",
"payment_details": {"gateway_name": "Stripe Default Name",
"gateway_customer_id": "cus_123456789",
"gateway_payment_id": "card_123456"
},
"discount_code": "DISCOUNTCODE",
"note": "Staff note",
"order_note": "Customer note"
}
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Get Subscription

Retrieve a subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Update Subscription

Update a subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

object (SubscriptionEntity)

external_id required	string or null
customer required	any
next_order_datetime required	string
next_payment_datetime required	string
next_processing_datetime required	string
subscription_status required	string Enum: "active" "inactive" "paused" "scheduled" "processing" "app_uninstalled" "waiting_sca_authorization"
payment_method_token required	string
payment_gateway_public_id required	string or null
payment_rrule required	string
payment_rrule_text required	string or null
order_rrule required	string
order_rrule_text required	string or null
last_payment_datetime required	string or null
last_order_datetime required	string or null
last_processed_datetime required	string or null
current_retries required	integer
charged_currency required	string
base_to_charged_exchange_rate required	integer
base_currency required	string
	object (CustomerAddressEntity)
	object (CustomerAddressEntity)
idempotency_key required	string
placed_at	string or null <data-time>
discount_code required	string
billing_address_id required	integer
shipping_address_id required	integer
orders_processed	integer or null
last_failure_code	string or null Enum: "alt_pp_payment_method_required" "bigcommerce_error" "card_declined" "card_expired" "credit_card_not_found" "discount_code_use_limit" "insufficient_funds" "invalid_billing_address" "invalid_bold_api_token" "invalid_card_expiration_month" "invalid_card_expiration_year" "invalid_card_number" "invalid_customer_email" "invalid_discount_code" "invalid_payment_method" "invalid_security_code" "invalid_shipping_address" "invalid_zip_code" "no_payment_provider" "payment_method_declined" "plugin_event_failed" "shopify_error" "stripe_support_required" "transaction_declined" "unaccepted_credit_card" "unknown_error" "unsupported_card" "unsupported_purchase_type" "unsupported_shipping_address" "woocommerce_error" This code may help to identify the type of the error.
	object or null Default error messages for the last_failure_code field
last_failure_reason	string or null Enum: "credit_card" "gateway" "cashier" "platform" "inventory" "other" The reason for the failure
	object (StatusLogEntity)
note required	string or null An internal-only note that you can add to a subscription. For a subscription recurrence, this note appears in the Additional Details section of the created order. Applicable for Shopify Checkout only.
order_note required	string or null A customer-facing note that you can add to a subscription. For the first order, this field retains the note added by the customer. For a subscription recurrence, this note appears in the Note section of the created order. Applicable for Shopify Checkout only.

Responses

Request samples

Payload

Content type

application/json

{"subscription": {"external_id": "string",
"customer": "null",
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"billing_address": {"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true
},
"shipping_address": {"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"discount_code": "DISCOUNTCODE",
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Partial Update Subscription

Partially update a subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

object (PartialUpdateSubscriptionEntity)

current_retries	integer
note	string or null An internal-only note that you can add to a subscription. For a subscription recurrence, this note appears in the Additional Details section of the created order. Applicable for Shopify Checkout only.
order_note	string or null A customer-facing note that you can add to a subscription. For the first order, this field retains the note added by the customer. For a subscription recurrence, this note appears in the Note section of the created order. Applicable for Shopify Checkout only.

Responses

Request samples

Payload

Content type

application/json

{"subscription": {"current_retries": 6,
"note": "Staff note",
"order_note": "Customer note"
}
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

List Subscription Intervals

Retrieve a list of available intervals for a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"intervals": [{"interval_number": 1,
"interval_type": "month",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": 1,
"month_occurrence": "",
"month_occurrence_day": 1,
"year_type": "",
"year_month": 1,
"year_occurrence": "",
"year_occurrence_day": 1,
"interval_name": "Monthly",
"id": 1,
"billing_rule": "DTSTART:20191120T205526Z\\nRRULE:FREQ=MONTHLY"
}
]
}

Update Subscription Interval

Update the interval of a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_interval_id required	integer Subscription interval ID to view and manage data for.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Swap Line Items

Swap line item products on a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

Array of objects (SwapProductEntity) [ items ]

Array

line_item_id	integer
platform_product_id	string
platform_variant_id	string
subscription_group_id	integer

Responses

Request samples

Payload

Content type

application/json

{"swap_products": [{"line_item_id": 1,
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1
}
]
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

List Orders

Retrieve a list of subscription orders for a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

query Parameters

page	integer The desired page number for the paginated result
limit	integer Maximum number of results to be returned

Responses

Response samples

Content type

application/json

{"subscription_orders": [{"id": 151917,
"subscription_id": 5266,
"shop_id": 29875,
"currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"order": {"id": 185490,
"platform_id": 1,
"platform_customer_id": 123,
"shop_identifier": "zya0kzb8hu",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_addresses": [{"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"subtotal": 1337,
"subtotal_charged": 1337,
"subtotal_tax": 144,
"subtotal_tax_charged": 144,
"shipping_subtotal": 1000,
"shipping_subtotal_charged": 1000,
"shipping_tax": 0,
"shipping_tax_charged": 0,
"total": 2204,
"total_charged": 2204,
"total_tax": 144,
"total_tax_charged": 144,
"fulfillment_status": "pending",
"source": "string",
"payment_method": "Shopify Payments",
"payment_method_details": {"type": "credit_card",
"public_id": "jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"update_method": "trigger_email",
"cc_type": "Visa",
"expiration": {"date": "2020-5",
"timezone_type": "string",
"timezone": "UTC"
},
"last_four": "1111",
"is_default": true,
"paypal_email": "customer@example.com",
"update_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
},
"embed_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}
},
"shipping_method": "Subscription shipping",
"shipping_rates": [{"id": 0,
"bold_subscription_id": 0,
"name": "string",
"code": "string",
"price": 0,
"price_charged": 0,
"value": 0,
"value_charged": 0,
"tag": "string",
"hash": "string"
}
],
"tax_lines": [{"amount": 0,
"amount_charged": 0,
"name": "string",
"rate": 0
}
],
"discounts": [{"discount_percentage": 10,
"discount_type": "percentage",
"text": "10PERCENTOFF",
"value": 0,
"value_charged": 0
}
],
"order_number": 0,
"currency": "CAD",
"currency_charged": "string",
"currency_format": "string",
"currency_format_charged": "string",
"exchange_rate": 0,
"test": false,
"url": "https://example-store.example.com/account.php?action=view_order&order_id=1",
"updated_at": "2019-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"placed_at": "2019-11-20T20:31:55Z",
"deleted_at": "2021-07-09T18:13:27Z",
"subscription_id": 5266
},
"is_multi_currency": false,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
]
}

Get Order

Retrieve a subscription order for a subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
order_id required	integer Order ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"id": 1008130,
"subscription_id": 316561,
"shop_id": 6481,
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"order": {"id": 185490,
"platform_id": 1,
"platform_customer_id": 123,
"shop_identifier": "zya0kzb8hu",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_addresses": [{"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"subtotal": 1337,
"subtotal_charged": 1337,
"subtotal_tax": 144,
"subtotal_tax_charged": 144,
"shipping_subtotal": 1000,
"shipping_subtotal_charged": 1000,
"shipping_tax": 0,
"shipping_tax_charged": 0,
"total": 2204,
"total_charged": 2204,
"total_tax": 144,
"total_tax_charged": 144,
"fulfillment_status": "pending",
"source": "string",
"payment_method": "Shopify Payments",
"payment_method_details": {"type": "credit_card",
"public_id": "jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"update_method": "trigger_email",
"cc_type": "Visa",
"expiration": {"date": "2020-5",
"timezone_type": "string",
"timezone": "UTC"
},
"last_four": "1111",
"is_default": true,
"paypal_email": "customer@example.com",
"update_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
},
"embed_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}
},
"shipping_method": "Subscription shipping",
"shipping_rates": [{"id": 0,
"bold_subscription_id": 0,
"name": "string",
"code": "string",
"price": 0,
"price_charged": 0,
"value": 0,
"value_charged": 0,
"tag": "string",
"hash": "string"
}
],
"tax_lines": [{"amount": 0,
"amount_charged": 0,
"name": "string",
"rate": 0
}
],
"discounts": [{"discount_percentage": 10,
"discount_type": "percentage",
"text": "10PERCENTOFF",
"value": 0,
"value_charged": 0
}
],
"order_number": 0,
"currency": "CAD",
"currency_charged": "string",
"currency_format": "string",
"currency_format_charged": "string",
"exchange_rate": 0,
"test": false,
"url": "https://example-store.example.com/account.php?action=view_order&order_id=1",
"updated_at": "2019-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"placed_at": "2019-11-20T20:31:55Z",
"deleted_at": "2021-07-09T18:13:27Z",
"subscription_id": 5266
},
"is_multi_currency": true,
"created_at": "2021-07-09T18:13:40Z",
"updated_at": "2021-07-09T18:13:40Z"
}

List Future Orders

Retrieve a list of future orders for a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

query Parameters

page	integer The desired page number for the paginated result
limit	integer Maximum number of results to be returned

Responses

Response samples

Content type

application/json

{"future_orders": [{"id": "5266-2020-01-20T18:00:00Z",
"date": "2020-01-20T18:00:00Z",
"quantity_exceptions": [{ }
],
"is_skipped": false,
"subscription_id": 5266
}
],
"pagination": {"count": 2,
"current_page": 1,
"per_page": 10,
"total": 2,
"total_pages": 1
}
}

Get Payment Method

Retrieve the current payment method information of a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"payment_method": {"type": "credit_card",
"public_id": "jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"update_method": "trigger_email",
"cc_type": "Visa",
"expiration": {"date": "2020-5",
"timezone_type": "string",
"timezone": "UTC"
},
"last_four": "1111",
"is_default": true,
"paypal_email": "customer@example.com",
"update_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
},
"embed_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}
}
}

Trigger Update Payment Method Email

Note: Available for Shopify Checkout only.

Trigger an email to the customer that allows them to update their payment method for the subscription. This endpoint can only be called if the subscription's payment method has an update_method of trigger_email.

You can change the contents of the email in Shopify's "Customer payment method update request" email settings.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{ }

List Payment Methods

Retrieve a list of available payment methods for a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"payment_methods": [{"type": "credit_card",
"public_id": "jik1w6HrCn17CxXPDkWhtgyqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"update_method": "trigger_email",
"cc_type": "Visa",
"expiration": {"date": "2020-5",
"timezone_type": "string",
"timezone": "UTC"
},
"last_four": "1111",
"is_default": true,
"paypal_email": "customer@example.com",
"update_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
},
"embed_url": {"url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}
}
]
}

Update Line Items

Update the line items of a subscription. Refer to Manage Subscription Line Items for more information about the use cases of this endpoint.

When updating the price of the line item, change the price field in the request body. This value must be in the charged_currency of the subscription, and it must be in the base currency unit (i.e., cents). This price is the final output price of the line item on this order; any applicable subscription group discounts or price changes will not be applied.

Example: If you include price: 4000 in the request body, the line item price is set to $40.00 CAD for all upcoming orders.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

object

Array of objects (PatchLineItemEntity) [ items ]

Array

id required	integer or null Read-only. Line item identifier.
subscription_id required	integer or null Read-only. Subscription identifier.
platform_id required	string Read-only. Identifier from the platform.
platform_product_id required	string or null Read-only. Product identifier from the platform.
platform_variant_id required	string or null Read-only. Variant identifier from the platform.
subscription_group_id required	integer Subscription group identifier.
subscription_group_billing_rules_id required	integer or null Billing rules identifier for the subscription group.
title required	string Line item title.
product_name required	string or null Read-only. Product name.
variant_name required	string or null Read-only. Variant name.
sku required	string Product SKU.
url required	string Read-only. Product URL.
image required	string Product image.
quantity required	integer Product quantity.
price required	integer Product price. If changed, all related `price` fields may be impacted.
price_charged required	integer or null Read-only. Influenced by changes made to the `price` field.
discounted_price required	integer Read-only. Influenced by changes made to the `price` field.
discounted_price_charged required	integer Read-only. Influenced by changes made to the `price` field.
full_price required	integer Read-only. Influenced by changes made to the `price` field.
full_price_charged	integer Read-only. Influenced by changes made to the `price` field.
requires_shipping required	boolean Whether or not the line item requires shipping.
grams required	integer Product weight in grams.
weight required	number Product weight in `weight_unit`.
weight_unit required	string Unit used for `weight`.
taxable required	boolean Whether or not the line item is taxable.
required	Array of objects (LineItemDiscountEntity) [ items ] Read-only. All discounts associated with the line item.
required	object or null Read-only. Prepaid properties.
	Array of objects (LineItemAttributeEntity) [ items ] Read-only. Additional attributes associated with the line item. Use the Update Line Item Attributes endpoint to add, update, or delete line item attributes.

Responses

Request samples

Payload

Content type

application/json

{"subscription": {"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack"
}
],
"prepaid_metadata": {"prepaid_metadata": {"id": 1,
"line_item_id": 1,
"prepaid_continue": "as_prepaid",
"prepaid_duration": 6,
"current_recurrence_count": 6
}
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL"
}
]
}
]
}
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": null,
"variant_name": null,
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Update Next Order Datetime

Update the datetime of the next subscription order in RFC 3339 format.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

nextDate	string
includeFutureOrders	boolean Default: false Also adjust the order datetimes of all future orders to match the new next order date with the old interval.

Responses

Request samples

Payload

Content type

application/json

{"nextDate": "2020-01-20T18:00:00Z",
"includeFutureOrders": false
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Unskip Previously Skipped Order

Restore a previously skipped future subscription order. Specify the date of the order to be unskipped.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

date	string Date of the previously skipped order (to be restored/unskipped)

Responses

Request samples

Payload

Content type

application/json

{"date": "2020-01-20T18:00:00Z"
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Skip Subscription Order

Skip a subscription's upcoming order by date.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

date

string

Responses

Request samples

Payload

Content type

application/json

{"date": "2020-01-20T18:00:00Z"
}

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Reactivate Subscription

Reactivate an inactive or cancelled subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Cancel Subscription

Cancel a subscription and any future orders. Cancelled subscriptions will appear as 'inactive'.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Pause Subscription

Pause a subscription and any future orders. Paused orders will still appear as 'active'.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Delete Line Item

Delete a line item from a subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription": {"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}
}

Get Line Item

Retrieve the details of a specific line item from a given subscription.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription_line_item": {"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 1,
"line_item_id": 1
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
}

List Swappable Products by Line Item

Retrieve a list of swappable products for a subscription line item.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

query Parameters

limit	integer Maximum number of results to be returned
page	integer The desired page number for the paginated result

Responses

Response samples

Content type

application/json

{"swappable_products": [{"price": 1337,
"price_charged": 1337,
"discounted_price": 1337,
"discounted_price_charged": 1337,
"has_discount": true,
"url": "https://example-store.example.com/monthly-expansion-pack",
"variants": [{"platform_id": "1",
"platform_product_id": "112",
"name": "Size Small",
"sku": "SKU-112-Small",
"price": 1337,
"price_charged": 1337,
"discounted_price": 1337,
"discounted_price_charged": 1337,
"discounted_cost": 1337,
"discounted_cost_charged": 1337,
"cost": 0,
"weight": 1.5,
"weight_unit": "kg",
"grams": 1500,
"image_id": 0,
"image_url": "",
"allow_backorder": false,
"inventory_quantity": 0,
"inventory_tracking_service": "platform",
"inventory_tracking_entity": "product"
}
],
"image": "https://example.com/s-sadjid0asd/products/112/images/376/example-store__33773.1574282899.386.513.png?c=1",
"product_image": "https://example.com/s-sadjid0asd/products/112/images/376/example-store__33773.1574282899.386.513.png?c=1",
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"platform_product_id": "1357908642",
"subscription_group_id": 1
}
],
"pagination": {"count": 2,
"current_page": 1,
"per_page": 10,
"total": 2,
"total_pages": 1
}
}

List Alternative Payment Methods

Retrieve a list of alternative payment methods for a subscription.

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"gift_card": [{"payment_public_id": "string",
"card_number": "string",
"balance": 0
}
]
}

Create Alternative Payment Method

Add an alternate payment method to a subscription.

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.

Request Body schema: application/json

required

Array of objects 1 items unique [ items ]

Array (1 items)

type required	string non-empty
	object

Responses

Request samples

Payload

Content type

application/json

Example

example-1

{"alternative_payment_methods": [{"type": "gift_card",
"payment_details": {"card_number": "ABC1234",
"security_key": "123"
}
}
]
}

Response samples

Content type

application/json

{"alternative_payment_methods": [{"subscription_id": 0,
"public_payment_token": "string"
}
]
}

Delete Alternative Payment Method

Remove an alternative payment method from a subscription its paymentPublicID.

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
payment_public_id required	string

Responses

Create Line Item Attributes

Add a new set of attributes to a line item.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Request Body schema: application/json

Array of objects (LineItemAttributeEntity) [ items ]

Array

name	string Name of the custom field/attribute, up to 250 characters.
value	string Content of the custom field/attribute.

Responses

Request samples

Payload

Content type

application/json

{"line_item_attributes": [{"name": "size_preference",
"value": "XL"
},
{"name": "color_preference",
"value": "green"
}
]
}

Response samples

Content type

application/json

{"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 1,
"line_item_id": 1
},
{"name": "color_preference",
"value": "green",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 1,
"line_item_id": 1
}
]
}

Update Line Item Attributes

Create, remove, or update attributes for a specific line item inside a subscription. Your request payload must contain the full list of attributes for the line item.

To add an attribute to the line item, include a new attribute in the request payload. To update an attribute that already exists on the line item, include the attribute in the payload with the same name and an updated value. To delete one attribute, leave the attribute out of the request payload. To remove all attributes of a line item, use an empty array as the request payload.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Request Body schema: application/json

Array of objects (LineItemAttributeEntity) [ items ]

Array

name	string Name of the custom field/attribute, up to 250 characters.
value	string Content of the custom field/attribute.

Responses

Request samples

Payload

Content type

application/json

{"line_item_attributes": [{"name": "size_preference",
"value": "XL"
},
{"name": "color_preference",
"value": "green"
}
]
}

Response samples

Content type

application/json

{"subscription_line_item": {"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 1,
"line_item_id": 1
},
{"name": "color_preference",
"value": "green",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 1,
"line_item_id": 1
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
}

Create Line Item Prepaid Metadata

Add prepaid metadata to a line item to convert a subscription to prepaid. Adding this metadata to one line item converts the whole order to prepaid.

Note: Converting a subscription to prepaid does not automatically charge the customer for the balance of the prepaid subscription. To charge the customer the prepaid subscription amount on the next recurrence, set prepaid_duration to the same value as prepaid_recurrence_count, and set prepaid_continue to as_prepaid. This causes Bold to start a new prepaid subscription on the next recurrence and set the prepaid_recurrence_count back to 1.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Request Body schema: application/json

object (PrepaidMetadataEntity)

id	integer The id of the prepaid metadata item.
line_item_id	integer The id of the parent line item.
prepaid_continue required	string Enum: "no_continue" "as_prepaid" "as_standard" The behavior of the subscription once the number of recurrences has reached the `prepaid_duration`. `no_continue`: The subscription will be cancelled. `as_prepaid` : The customer will be charged for new set of order recurrences on the next recurrence. `as_standard`: The subscription will be converted to a standard subscription, where the customer is charged for one order at each recurrence.
prepaid_duration required	integer The number of subscription recurrences that have been prepaid.
current_recurrence_count required	integer The number of subscription recurrences that have occurred.

Responses

Request samples

Payload

Content type

application/json

{"prepaid_metadata": {"prepaid_continue": "as_prepaid",
"prepaid_duration": 6,
"current_recurrence_count": 6
}
}

Response samples

Content type

application/json

{"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
}
}

Update Line Item Prepaid Metadata

Update or create new prepaid metadata for a line item.

Note: Updating the prepaid_duration or current_recurrence_count does not result in any automatic charges or change in charges to an existing prepaid customer. Adding new prepaid metadata to a subscription converts it to prepaid. For more information on converting a subscription to prepaid, refer to the Create Line Item Prepaid Metadata endpoint.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
subscription_id required	integer Subscription ID to view and manage data for.
line_item_id required	integer Line item ID to view and manage data for.

Request Body schema: application/json

object (PrepaidMetadataEntity)

id	integer The id of the prepaid metadata item.
line_item_id	integer The id of the parent line item.
prepaid_continue required	string Enum: "no_continue" "as_prepaid" "as_standard" The behavior of the subscription once the number of recurrences has reached the `prepaid_duration`. `no_continue`: The subscription will be cancelled. `as_prepaid` : The customer will be charged for new set of order recurrences on the next recurrence. `as_standard`: The subscription will be converted to a standard subscription, where the customer is charged for one order at each recurrence.
prepaid_duration required	integer The number of subscription recurrences that have been prepaid.
current_recurrence_count required	integer The number of subscription recurrences that have occurred.

Responses

Request samples

Payload

Content type

application/json

{"prepaid_metadata": {"prepaid_continue": "no_continue",
"prepaid_duration": 6,
"current_recurrence_count": 6
}
}

Response samples

Content type

application/json

{"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
}
}

Subscription groups

View and manage subscription groups

List Subscription Groups

Retrieve a list of subscription groups.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Responses

Response samples

Content type

application/json

{"subscription_groups": [{"id": 3,
"shop_id": 1,
"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"percent_discount": 11,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"allow_buffer_days": true,
"discount_type": "fixed",
"fixed_discount": 10,
"created_at": "2019-11-20T20:50:07Z",
"updated_at": "2019-11-20T20:50:07Z",
"deleted_at": null,
"active_subscribers_count": 1,
"billing_rules": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "",
"year_type": "",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"created_at": "2019-11-20T20:50:07Z",
"updated_at": "2019-11-20T20:50:07Z",
"deleted_at": null
}
],
"selection_options": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"platform_entity_id": "1357908642",
"created_at": "2019-11-20T20:50:07Z",
"updated_at": "2019-11-20T20:50:07Z",
"deleted_at": null,
"entity_id": 1472540
}
],
"prepaid_durations": [{ }
]
}
]
}

Create Subscription Group

Create a subscription group.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Request Body schema: application/json

object (SubscriptionGroupEntity)

internal_name required	string
is_enabled required	boolean
platform_id required	string
allow_prepaid required	boolean
is_prepaid_only required	boolean
should_continue_prepaid required	boolean
continue_prepaid_type required	string Enum: "as_prepaid" "as_standard"
allow_buffer_days required	boolean
discount_type required	string Enum: "no_discount" "percentage" "fixed"
percent_discount required	number
fixed_discount required	integer
minimum_order_count_before_cancellable required	integer
is_product_swappable required	boolean
is_subscription_only required	boolean
selection_type required	string Enum: "products" "collections"
group_type required	string Enum: "selectable" "fixed"
selectable_daily_allowed required	boolean
selectable_weekly_allowed required	boolean
selectable_yearly_allowed required	boolean
selectable_max_interval_frequency required	integer
fixed_interval_type required	string Enum: "daily" "weekly" "monthly" "yearly"
is_fixed_billing required	boolean
can_add_to_cart required	boolean
required	Array of objects (BillingRuleEntity) [ items ]
required	Array of objects (SelectionOptionEntity) [ items ]
required	Array of objects (PrepaidDuration) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"subscription_group": {"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"allow_buffer_days": true,
"discount_type": "no_discount",
"percent_discount": 11,
"fixed_discount": 0,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"billing_rules": [{"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "MO",
"year_type": "purchase_day",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"custom_billing_rule": "string",
"buffer_days": 365,
"buffer_time": "01:00:00"
}
],
"selection_options": [{"platform_entity_id": "1357908642",
"bold_platform_entity_id": 1234
}
],
"prepaid_durations": [{"total_duration": 1,
"discount_value": 0,
"discount_type": "percentage"
}
]
}
}

Response samples

Content type

application/json

{"subscription_group": {"id": 19364,
"shop_id": 8846,
"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"allow_buffer_days": true,
"discount_type": "no_discount",
"percent_discount": 11,
"fixed_discount": 0,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"active_subscribers_count": 1,
"billing_rules": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "MO",
"year_type": "purchase_day",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"custom_billing_rule": "string",
"buffer_days": 365,
"buffer_time": "01:00:00"
}
],
"selection_options": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"platform_entity_id": "1357908642",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"entity_id": 1472540,
"bold_platform_entity_id": 1234
}
],
"prepaid_durations": [{"id": 0,
"total_duration": 1,
"discount_value": 0,
"discount_type": "percentage",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
]
}
}

Get Subscription Group

Retrieve a subscription group by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"subscription_group": {"id": 19364,
"shop_id": 8846,
"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"allow_buffer_days": true,
"discount_type": "no_discount",
"percent_discount": 11,
"fixed_discount": 0,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"active_subscribers_count": 1,
"billing_rules": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "MO",
"year_type": "purchase_day",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"custom_billing_rule": "string",
"buffer_days": 365,
"buffer_time": "01:00:00"
}
],
"selection_options": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"platform_entity_id": "1357908642",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"entity_id": 1472540,
"bold_platform_entity_id": 1234
}
],
"prepaid_durations": [{"id": 0,
"total_duration": 1,
"discount_value": 0,
"discount_type": "percentage",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
]
}
}

Update Subscription Group

Update a subscription group by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.

Request Body schema: application/json

object (SubscriptionGroupEntity)

internal_name required	string
is_enabled required	boolean
platform_id required	string
allow_prepaid required	boolean
is_prepaid_only required	boolean
should_continue_prepaid required	boolean
continue_prepaid_type required	string Enum: "as_prepaid" "as_standard"
allow_buffer_days required	boolean
discount_type required	string Enum: "no_discount" "percentage" "fixed"
percent_discount required	number
fixed_discount required	integer
minimum_order_count_before_cancellable required	integer
is_product_swappable required	boolean
is_subscription_only required	boolean
selection_type required	string Enum: "products" "collections"
group_type required	string Enum: "selectable" "fixed"
selectable_daily_allowed required	boolean
selectable_weekly_allowed required	boolean
selectable_yearly_allowed required	boolean
selectable_max_interval_frequency required	integer
fixed_interval_type required	string Enum: "daily" "weekly" "monthly" "yearly"
is_fixed_billing required	boolean
can_add_to_cart required	boolean
required	Array of objects (BillingRuleEntity) [ items ]
required	Array of objects (SelectionOptionEntity) [ items ]
required	Array of objects (PrepaidDuration) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"subscription_group": {"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"allow_buffer_days": true,
"discount_type": "no_discount",
"percent_discount": 11,
"fixed_discount": 0,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"billing_rules": [{"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "MO",
"year_type": "purchase_day",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"custom_billing_rule": "string",
"buffer_days": 365,
"buffer_time": "01:00:00"
}
],
"selection_options": [{"platform_entity_id": "1357908642",
"bold_platform_entity_id": 1234
}
],
"prepaid_durations": [{"total_duration": 1,
"discount_value": 0,
"discount_type": "percentage"
}
]
}
}

Response samples

Content type

application/json

{"subscription_group": {"id": 19364,
"shop_id": 8846,
"internal_name": "Standard Subscription",
"is_enabled": true,
"platform_id": "gid://shopify/SellingPlanGroup/132016692",
"allow_prepaid": false,
"is_prepaid_only": false,
"should_continue_prepaid": false,
"continue_prepaid_type": "as_prepaid",
"allow_buffer_days": true,
"discount_type": "no_discount",
"percent_discount": 11,
"fixed_discount": 0,
"minimum_order_count_before_cancellable": 0,
"is_product_swappable": false,
"is_subscription_only": false,
"selection_type": "products",
"group_type": "selectable",
"selectable_daily_allowed": false,
"selectable_weekly_allowed": false,
"selectable_yearly_allowed": false,
"selectable_max_interval_frequency": 0,
"fixed_interval_type": "monthly",
"is_fixed_billing": false,
"can_add_to_cart": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"active_subscribers_count": 1,
"billing_rules": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"interval_number": 1,
"interval_type": "month",
"interval_name": "Monthly",
"week_type": "",
"week_day": 0,
"month_type": "purchase_day",
"month_day": "",
"month_occurrence": "",
"month_occurrence_day": "MO",
"year_type": "purchase_day",
"year_month": "",
"year_occurrence": "",
"year_occurrence_day": "",
"billing_rule": "FREQ=MONTHLY",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"custom_billing_rule": "string",
"buffer_days": 365,
"buffer_time": "01:00:00"
}
],
"selection_options": [{"id": 1,
"shop_id": 1,
"subscription_group_id": 1,
"platform_entity_id": "1357908642",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null,
"entity_id": 1472540,
"bold_platform_entity_id": 1234
}
],
"prepaid_durations": [{"id": 0,
"total_duration": 1,
"discount_value": 0,
"discount_type": "percentage",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
]
}
}

Delete Subscription Group

Delete a subscription group by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.

Responses

Delete Selection Option by ID

Delete a selection option from inside a subscription group.

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.
selection_option_id required	string Selection option ID of the item to be deleted from the group.

Responses

Delete Selection Option by Filter

Delete one or more selection options from inside a subscription group.

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.

query Parameters

filter

required

string

Accepts filtering options as described here: https://developer.boldcommerce.com/guides/getting-started/query-pagination. Example: to remove the platform product IDs 1, 2 and 3 from a subscription group, the following query param must be added: ?filter=in(platform_entity_id:1,2,3)

Responses

Add Selection Options by Platform Product ID(s)

Add one or more selection options from inside a subscription group.

path Parameters

shop_identifier required	string The unique identifier of the shop.
group_id required	integer Subscription group ID to view and manage data for.

Request Body schema: application/json

Add one or more selection options to a subscription group. Right now the only supported selection option is product. A list of platform product IDs can be passed as platform_entity_ids.

required

object

required

object

platform_entity_ids

required

Array of integers[ items ]

These are product ids we are look

Responses

Request samples

Payload

Content type

application/json

{"subscription_group": {"selection_options": {"platform_entity_ids": [7021943390389,
7003068956853,
7014441746613
]
}
}
}

Webhook events

View past webhook event results

List Webhook Events

Retrieve a list of webhook events.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

query Parameters

since_id	integer
limit	string Maximum number of results to be returned
filters	Array of strings Items Enum: "shop_id" "webhook_subscription_id" "webhook_topic_id" "uuid" "attempts" "last_response_status_code" "id" "created_at" "updated_at" "delivered_at" Filter event webhooks. Mulitple filters can be passed in the array.

Responses

Response samples

Content type

application/json

{"webhook_events": [{"id": 0,
"shop_id": 0,
"webhook_subscription_id": 0,
"webhook_topic_id": 0,
"uuid": "string",
"attempts": 0,
"last_response_status_code": "string",
"delivered_at": "string",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
],
"pagination": {"limit": 10,
"count": 1,
"total": 1,
"total_pages": 1
}
}

Get Webhook Event

Retrieve a webhook event by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
webhook_event_id required	integer Webhook event ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"webhook_event": {"id": 0,
"shop_id": 0,
"webhook_subscription_id": 0,
"webhook_topic_id": 0,
"uuid": "string",
"attempts": 0,
"last_response_status_code": "string",
"delivered_at": "string",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
}

Webhook subscriptions

View and manage subscriptions to webhook topics

List Webhook Subscriptions

Retrieve a list of webhook subscriptions.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

query Parameters

since_id	integer
limit	string Maximum number of results to be returned
filters	Array of strings Items Enum: "webhook_topic_id" "callback_url" "shared_secret" "created_at" "updated_at" Filter subscription webhooks. Mulitple filters can be passed in the array.

Responses

Response samples

Content type

application/json

{"webhook_subscriptions": [{"id": 1,
"shop_id": 1,
"webhook_topic_id": 1,
"callback_url": "yourapp.com/v2/sub-created",
"created_at": "2020-09-17T18:27:03Z",
"updated_at": "2020-09-17T18:27:03Z",
"deleted_at": null
},
{"id": 1,
"shop_id": 1,
"webhook_topic_id": 2,
"callback_url": "yourapp.com/sub-updated",
"created_at": "2020-08-17T18:27:03Z",
"updated_at": "2020-08-17T18:27:03Z",
"deleted_at": null
}
],
"pagination": {"limit": 10,
"count": 2,
"total": 2,
"total_pages": 1
}
}

Create Webhook Subscription

Create a webhook subscription. For more information, refer to Register for Webhooks.

Authorizations:

bearerAuth

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Request Body schema: application/json

required

object

webhook_topic_id required	integer [ 1 .. 10 ]
callback_url required	string <uri>
shared_secret required	string

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"webhook_subscription": {"webhook_topic_id": 10,
"callback_url": "https://webhooks.shop.com",
"shared_secret": "exMh194qw8JD@A50dA^P"
}
}

Response samples

Content type

application/json

{"webhook_subscription": {"id": 0,
"shop_id": 0,
"webhook_topic_id": 0,
"callback_url": "string",
"shared_secret": "string",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
}

Callback payload samples

Callback

POST: Subscription Created

Content type

application/json

{"id": 1,
"external_id": "string",
"customer": "null",
"shop_id": 1,
"next_order_datetime": "2020-01-20T18:00:00Z",
"next_payment_datetime": "2020-01-20T18:00:00Z",
"next_processing_datetime": "2020-01-20T18:00:00Z",
"subscription_status": "active",
"status_changed_at": "2019-11-20T20:31:55Z",
"sca_url": "https://bank.com/pCkWhtgQQVM8W/sca",
"payment_method_token": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_gateway_public_id": "jik1w6HrCn17CxXPcKwHTGqqvm8wLDd1PelY6k8mabglNmL8XKBnsde9PdgKZqnG",
"payment_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"payment_rrule_text": "Monthly",
"order_rrule": "DTSTART:20200120T180000Z\\nRRULE:FREQ=MONTHLY\\nEXDATE:20200220T180000Z",
"order_rrule_text": "Monthly",
"last_payment_datetime": "2019-11-20T20:55:26Z",
"last_order_datetime": "2019-11-20T20:55:26Z",
"last_processed_datetime": "2019-11-20T20:55:26Z",
"current_retries": 3,
"charged_currency": "CAD",
"base_to_charged_exchange_rate": 1,
"base_currency": "CAD",
"line_items": [{"id": 1,
"subscription_id": 1,
"platform_id": "ABC123",
"platform_product_id": "1357908642",
"platform_variant_id": "2468097531",
"subscription_group_id": 1,
"subscription_group_billing_rules_id": 1,
"title": "Monthly Expansion Pack",
"product_name": "Monthly Expansion Pack",
"variant_name": "Default Title",
"sku": "SKU-113-Red",
"url": "https://example-store.example.com/monthly-expansion-pack",
"image": "",
"quantity": 1,
"price": 3500,
"price_charged": 3200,
"discounted_price": 3200,
"discounted_price_charged": 3200,
"full_price": 3200,
"full_price_charged": 3200,
"requires_shipping": false,
"grams": 2200,
"weight": 2.2,
"weight_unit": "kg",
"taxable": true,
"discounts": [{"id": 1,
"subscription_line_item_id": 1,
"shop_id": 5,
"full_price": 5,
"discount_type": "percentage",
"percentage_value": 10,
"fixed_value": 0,
"fixed_value_charged": 0,
"description": "Subscription discount (10%) for Monthly Expansion Pack",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": "2019-11-20T20:31:55Z"
}
],
"prepaid_metadata": {"id": 1,
"line_item_id": 2,
"prepaid_duration": 2,
"current_recurrence_count": 2,
"prepaid_continue": "no_continue"
},
"line_item_attributes": [{"name": "size_preference",
"value": "XL",
"created_at": "2021-01-17T20:30:40Z",
"updated_at": "2021-01-17T20:30:40Z",
"subscription_id": 0,
"line_item_id": 0
}
],
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
}
],
"shipping_lines": [{"id": 0,
"name": "Standard Shipping",
"code": "Standard Shipping",
"price": 1000,
"value": 1000,
"value_charged": 1000,
"tag": "Shipping",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"subscription_id": 1
}
],
"billing_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"shipping_address": {"id": 0,
"shop_identifier": "string",
"platform_id": 0,
"customer_id": 0,
"platform_type": "shopify",
"platform_customer_id": 123456789,
"first_name": "John",
"last_name": "Doe",
"company": "Example Company",
"phone": "123-456-7890",
"street1": "123 example st.",
"street2": "101",
"city": "Toronto",
"province": "Ontario",
"province_code": "ON",
"country": "Canada",
"country_code": "CA",
"zip": "M5V 3L9",
"is_default": true,
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z"
},
"idempotency_key": "JwGdN55C4g1z5FXRO8Hp21CMxUxKyo6VcGSf3cUsjCgNyTtoeZcIsGM1We4p7pCe-0",
"placed_at": "2012-11-20T20:31:55Z",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"percent_discount": 10,
"discount_code": "DISCOUNTCODE",
"customer_id": 1697912,
"billing_address_id": 11697812,
"shipping_address_id": 11697812,
"orders_processed": 1,
"last_failure_code": "card_expired",
"last_failure_details": {"message": "The order couldn't process because the card was declined."
},
"last_failure_reason": "credit_card",
"latest_status_log": {"id": 0,
"subscription_status": "active",
"reason": "No reason given.",
"metadata": {"user": {"type": "store_admin",
"id": 12345,
"name": "John Smith"
}
},
"created_at": "2021-11-15T19:03:58Z",
"subscription_id": 123456
},
"note": "Staff note",
"order_note": "Customer note"
}

Get Webhook Subscription

Retrieve a webhook subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
webhook_subscription_id required	integer Webhook subscription ID to view and manage data for.

Responses

Response samples

Content type

application/json

{"webhook_subscription": {"id": 0,
"shop_id": 0,
"webhook_topic_id": 0,
"callback_url": "string",
"shared_secret": "string",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
}

Update Webhook Subscription

Update a webhook subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
webhook_subscription_id required	integer Webhook subscription ID to view and manage data for.

Request Body schema: application/json

object (WebhookSubscriptionEntity)

id	integer
shop_id	integer
webhook_topic_id	integer
callback_url	string
shared_secret	string

Responses

Request samples

Payload

Content type

application/json

{"webhook_subscription": {"id": 0,
"shop_id": 0,
"webhook_topic_id": 0,
"callback_url": "string",
"shared_secret": "string"
}
}

Response samples

Content type

application/json

{"webhook_subscription": {"id": 0,
"shop_id": 0,
"webhook_topic_id": 0,
"callback_url": "string",
"shared_secret": "string",
"created_at": "2019-11-20T20:31:55Z",
"updated_at": "2019-11-20T20:31:55Z",
"deleted_at": null
}
}

Delete Webhook Subscription

Delete a webhook subscription by its id.

Authorizations:

bearerAuth

path Parameters

shop_identifier required	string The unique identifier of the shop.
webhook_subscription_id required	integer Webhook subscription ID to view and manage data for.

Responses

Webhook topics

View available webhook topics

List Webhook Topics

Retrieve a list of available webhook topics.

path Parameters

shop_identifier

required

string

The unique identifier of the shop.

Responses

Response samples

Content type

application/json

{"webhook_topics": [{"id": 1,
"topic_name": "subscription_created"
},
{"id": 2,
"topic_name": "subscription_updated"
},
{"id": 3,
"topic_name": "subscription_order_created"
},
{"id": 4,
"topic_name": "customer_created"
},
{"id": 5,
"topic_name": "customer_updated"
},
{"id": 6,
"topic_name": "subscription_order_transaction_failed"
},
{"id": 7,
"topic_name": "subscription_order_max_retries_reached"
},
{"id": 8,
"topic_name": "subscription_payment_method_updated"
},
{"id": 9,
"topic_name": "subscription_upcoming_order"
},
{"id": 10,
"topic_name": "subscription_expiring_payment"
},
{"id": 12,
"topic_name": "subscription_cancelled"
},
{"id": 13,
"topic_name": "subscription_paused"
},
{"id": 14,
"topic_name": "subscription_resumed"
},
{"id": 15,
"topic_name": "subscription_reactivated"
},
{"id": 16,
"topic_name": "subscription_frequency_updated"
},
{"id": 17,
"topic_name": "subscription_quantity_updated"
},
{"id": 18,
"topic_name": "subscription_credit_card_updated"
},
{"id": 19,
"topic_name": "subscription_shipping_address_updated"
},
{"id": 20,
"topic_name": "subscription_payment_failed"
},
{"id": 21,
"topic_name": "subscription_skipped"
}
]
}