Endpoint
Authentication
string
required
Bearer token with your API key. Requires
read_write permission.Path Parameters
string
required
The project’s URL-friendly slug identifier.
Body Parameters
All fields are optional. Only provided fields are updated.General Settings
string
Project name. Maximum 100 characters.
string
Short project description.
string
Longer description shown on the pricing page header.
string
Currency code (e.g.
"USD", "EUR", "GBP").number
Discount for annual billing as a decimal (e.g.
0.2 for 20% off).boolean
Enable or disable the annual billing toggle.
boolean
Activate or deactivate the project.
Redirect URLs
These are the Redirects fields in the builder. Each must be a fullhttps:// or http:// address; send null or "" to clear one. See Redirect URLs.
string
Sent to your checkout link as
success_url: where your checkout sends the buyer after a successful payment. Defaults to your Cuprice share page.string
Sent to your checkout link as
cancel_url: where your checkout sends the buyer if they leave. Defaults to your Cuprice share page.string
Saved with the project. The checkout handoff does not use it.
string
Saved with the project. The checkout handoff does not use it.
Theme Settings
object
Visual customization settings for the pricing widget.
