Update a price - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

id

string

required

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

active

boolean

optional

Whether the price can be used for new purchases. Defaults to true.

metadata

string

optional

Set of key-value pairs that you can attach to an object.

nickname

string

optional

A brief description of the price, hidden from customers.

lookup_key

string

optional

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

Example

{
    "active": true,
    "metadata": "string",
    "nickname": "string",
    "lookup_key": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/prices/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "active": true,
    "metadata": "string",
    "nickname": "string",
    "lookup_key": "string"
}'

Responses

🟢200OK

application/json

Body

id

string

optional

Unique identifier for the object, like "price_xxxx".

object

string

optional

'price'

active

boolean

optional

Whether the price can be used for new purchases.

billing_scheme

enum<string>

optional

Describes how to compute the price per period. Either per_unit or tiered

Allowed values:

per_unittiered

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code, in uppercase.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

lookup_key

string

optional

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

nickname

string

optional

A brief description of the price, hidden from customers.

product

string

optional

The ID of the product this price is associated with.

type

enum<string>

optional

One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

Allowed values:

one_timerecurring

unit_amount

integer

optional

The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

tiers

array [object {3}]

optional

（未实现）

up_to

string

optional

Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use inf to define a fallback tier.

flat_amount

string

optional

The flat billing amount for an entire tier, regardless of the number of units in the tier.

unit_amount

string

optional

The per unit billing amount for each individual unit for which this tier applies.

Example

{
    "id": "string",
    "object": "string",
    "active": true,
    "billing_scheme": "per_unit",
    "created": 0,
    "currency": "string",
    "livemode": true,
    "lookup_key": "string",
    "metadata": {},
    "nickname": "string",
    "product": "string",
    "type": "one_time",
    "unit_amount": 0,
    "tiers": [
        {
            "up_to": "string",
            "flat_amount": "string",
            "unit_amount": "string"
        }
    ]
}