ChangelogGuidesRecipesAPI ReferenceRoadmap
HomeGuidesRecipesAPI ReferenceChangelog
ChangelogGuidesRecipesAPI ReferenceRoadmapSTART FREE TRIALSCHEDULE A DEMO
API Reference
START FREE TRIALSCHEDULE A DEMO
Start typing to search…

Update product

put
https://www.pelcro.com/api/v1/core/products/

Update an existing product.

Path Params
int32
required

Product ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
length between 3 and 250

Product name displayed on the site.

boolean

Whether a shipping address is required when subscribing to plans under this product.

string
length ≤ 1500

Customer-facing product description.

string
length between 3 and 250

Internal reference name (not visible to customers).

string
enum

Product language locale.

Allowed:
countries
array of strings

Array of ISO country codes to restrict the product to.

countries
string
length ≤ 22

Text that appears on customer bank statements. Letters, numbers, and spaces only.

file

Product image file upload.

boolean

Whether the product is hidden from public display.

boolean

Whether the product was imported from an external system.

string

AvaTax tax code for the product. See https://taxcode.avatax.avalara.com/ for valid codes.

string
length ≤ 191

External product ID from a previous provider. Must match import_unique_id if both are set.

string
length ≤ 191

Unique import identifier. Must match old_provider_id if both are set. Unique per account.

string
enum

Revenue recognition strategy. Only applies to accounts using Pelcro's Billing Engine (https://docs.pelcro.com/docs/our-billing-engine). Accepts: creation (recognize on creation) or payment (recognize on payment).

Allowed:
Headers
string
required
Defaults to Bearer eyJ***
Responses

Updated 5 days ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 days ago