Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Query Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

return_url
string<uri>
required

Where Shopify sends the merchant after they approve or decline the charge.

interval
enum<string>
default:EVERY_30_DAYS
Available options:
EVERY_30_DAYS,
ANNUAL

Body

application/json

Superuser sessions only; a merchant session sending one is 403.

percentage
number
required

Fraction off the price, e.g. 0.2 for 20%.

Required range: x <= 1
duration_intervals
integer
required

How many billing intervals the discount lasts.

Response

The pending subscription's confirmation URL.

confirmation_url
string
required