API Reference

Update a plan

patch
https://api.purchasely.io/management/v1/applications//plans/

Update a plan's attributes and/or promo offers. Store distributions (SKUs) are managed separately, via the distributions endpoints.

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
string

iOS App Store commitment billing mode for a subscription (optional). "up_front" = charged the full period at purchase ("1 Year Upfront", the default behavior). "monthly" = "Monthly with 12-Month Commitment" — charged monthly with a 12-month commitment; requires a matching SKU in App Store Connect (SDK v6.0+, iOS 26.4+). Worth surfacing for yearly subscription plans; leave blank otherwise.

string

Public ID of the screen (pres_…) to use as this plan's default.

string

Internal-only notes, never shown to end users.

integer

Ranking level used to compare plans (upgrade/downgrade detection).

string

Display name shown in console.

string

ISO-8601-ish duration, e.g. P1M, P1Y (required for subscriptions).

string

One of CONSUMABLE, NON_CONSUMABLE, NON_RENEWING_SUBSCRIPTION, RENEWING_SUBSCRIPTION.

promo_offers
array of objects

Promo offers for this plan. Each item accepts id (publicid) + destroy to edit/remove an existing one.

promo_offers
string

Unique vendor identifier for this plan, scoped to the mobile application.

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?