API Reference

Create a store distribution

post
https://api.purchasely.io/management/v1/applications//plans//distributions

Add a store distribution (the store SKU / store_product_id) to a plan. The app must already have that store's platform configured. For stripe, pass store_product_ids (an array of Stripe price IDs). store_product_id is frozen once a purchase has been made.

Required scope: setup.plans:edit

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public ID of the resource.

string
required

Public ID of the resource.

Query Params
fields[]
array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]
Body Params
boolean

play_store subscriptions only — true keeps Google Play Billing v4 backwards compatibility, false is v5-only. REQUIRED for a Play Store renewing subscription (a DB default of true would otherwise apply silently) — ask the user, do not guess. Ignored for one-time purchases; forced to false for non-renewing subs.

string

play_store subscriptions only — the Google Play base plan id (Billing v5): the part after ":" in a combined "<subscription_id>:<base_plan_id>" SKU. OMIT it when you already included ":<base_plan_id>" in store_product_id.

boolean

play_store only — mark this as a Subscribe with Google distribution.

boolean

When true, refuse replacing any existing has-one store distribution or re-adding a linked Stripe price. New Stripe prices remain additive. Use for safe catalog imports.

string
required

Which store this SKU is for: app_store (iOS), play_store (Android), amazon, huawei, or stripe.

string

The store SKU / product identifier for app_store/play_store/amazon/huawei. Frozen once a purchase has been made against it. For a play_store subscription the Google Play SKU is "<subscription_id>:<base_plan_id>" (":" separator) — pass the combined value here directly (do this when the user gives you a SKU containing ":"), OR pass the subscription_id here and the base plan id separately in google_base_plan_id. Never do both, or the base plan id is duplicated.

store_product_ids
array of strings

stripe only — the Stripe price IDs. A plan can have many stripe distributions; pass the full set (stripe is has_many, not one-per-plan).

store_product_ids
Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?