Update plan

put

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

Update an existing plan.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Plan ID.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

nickname

string

length ≤ 255

Plan display name visible to customers.

name_internal

string

length ≤ 255

Internal reference name (not visible to customers).

available_online

boolean

If true, the plan appears on your website for direct subscription.

amount

number

≥ 0

Plan price (e.g. 15.00 for $15.00). Set to 0 for a free plan.

refundable

boolean

If true, subscriptions on this plan can be refunded.

recognized_revenue_type

string

enum

How revenue is recognized: by time period or by shipments delivered.

Allowed:

trial_period_days

integer

0 to 730

Number of free trial days (0 for no trial). Maximum 730 days.

description

string

Plan description displayed to customers.

entitlements

array

Access permissions granted by this plan. See Authorization for details.

entitlements

shipments_per_interval

integer

1 to 1000

Number of physical shipments per billing interval.

auto_uncollectible_days

integer

1 to 365

Days after invoice due date before auto-marking as uncollectible.

renewal_strategy

string

enum

Renewal behavior strategy.

Allowed:

expires_at

date

Plan expiration date (YYYY-MM-DD). Must be tomorrow or later.

ip_addresses

array of strings

IP addresses (CIDR notation) for IP-based auto-subscription. See Plans for details.

ip_addresses

domains

array of strings

Email domains for domain-based auto-subscription. See Plans for details.

domains

gift_description

string

Description shown when the plan is gifted. See Plans for details.

apple_product_id

string

length ≤ 100

Apple App Store product ID. See Plans for details.

countries

array of strings

ISO country codes to restrict plan availability.

countries

group_owner_plan_id

integer

Parent plan ID for group/family plans. See Plans for details.

original_amount

number

Original price before discount (stored in metadata).

original_discount_percentage

number

Discount percentage from original price (stored in metadata).

allow_send_invoice

boolean

If true, customers can subscribe via invoice (check/wire payment).

is_donation

boolean

If true, this plan is a donation (no content access).

is_hidden

boolean

If true, the plan is hidden from public display.

member_seat_capacity

integer

≥ 1

Maximum member seats for membership plans.

old_provider_id

string

length ≤ 191

External plan ID from a previous provider.

is_imported

boolean

Whether the plan was imported from an external system.

invoice_upcoming_notification

integer

≥ 1

Days before renewal to send upcoming invoice notification.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

200Success.

400Invalid request.

401Unauthenticated.

404Not found.