Update a store distribution

patch

https://api.purchasely.io/management/v1/applications/{application_id}/plans/{plan_id}/distributions/{store}

Update a store's distribution on a plan (its store_product_id and, for play_store, the Google Play base plan / SwG settings). For stripe, store_product_ids REPLACES the whole stripe set. store_product_id is frozen once a purchase has been made.

Required scope: setup.plans:edit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

application_id

string

required

Public ID of the resource.

plan_id

string

required

Public ID of the resource.

store

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

google_base_plan_backwards_compatible

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.

google_base_plan_id

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.

is_swg

boolean

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

store_product_id

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. REPLACES the plan's entire stripe distribution set: send the full desired set; any existing price id you omit is removed.

store_product_ids

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

403FORBIDDEN (missing/insufficient scope, wrong tenant) or, for feature-gated operations, FEATURE_NOT_ENABLED.

422VALIDATION_FAILED — one or more parameters were missing or invalid.

429RATE_LIMITED — the coarse per-key, per-write, per-heavy-read, or per-moderate-read rate limit tier was exceeded.