Update plan (legacy)

post deprecated

https://www.pelcro.com/api/v1/core/plans/{id}

Legacy endpoint to update a plan via POST.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Plan unique identifier

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

_method

string

Defaults to PUT

Defining the method for update

nickname

string

The plan display name

name_internal

string

Internal reference name for the plan (not visible to public)

available_online

boolean

Use this key to define if plan is available "online and offline" or "offline" only

refundable

boolean

Use this key to define if plan is refundable or not

description

string

Plan description

entitlements

array of strings

The entitlements of articles which are available on the selected plan

entitlements

trial_period_days

int32

The plan trial period in days

shipments_per_interval

int32

auto_uncollectible_days

int32

renewal_strategy

string

enum

Allowed:

expires_at

date

The free plan expiry date

ip_addresses

array of strings

Plan IP addresses to allow plans for specific IPs

ip_addresses

domains

array of strings

Plan domains to allow plan for specific domains

domains

gift_description

string

image

file

Plan Image

apple_product_id

string

countries

array of strings

Countries which plan will be available in

countries

group_owner_plan_id

int32

Group owner plan ID if plan is a child from other plan

original_amount

int32

The plan amount before discount

original_discount_percentage

int32

The percentage of the discount on the original amount

allow_send_invoice

boolean

Use this key to define if we allowed to send invoices for this plan or not

is_donation

boolean

Is donation specifies if plan is for donation or not

old_provider_id

string

The current/old external plan ID associated with a migrated plan.

invoice_upcoming_notification

int32

Days before sending a reminder for any upcoming subscription sign-up or renewal invoices related to the configured plan

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Loading…

Response

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

application/json

200Success.

400Invalid request.

401Unauthenticated.

404Not found.