Create a price

POST

/v1/prices

Creates a new price for an existing product.

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 YWRtaW46MTIzNDU2

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

currency

string

required

Three-letter ISO currency code.

product

string

optional

The ID of the product that this price will belong to.

unit_amount

string

required

A positive integer in cents (or 0 for a free price) representing how much to charge.

active

string

optional

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

metadata

object

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.

product_data

object

optional

These fields can be used to create a new product that this price will belong to.

active

boolean

optional

Whether the product is currently available for purchase.

description

string

optional

The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

images

array[string]

optional

A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

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.

name

string

required

The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

url

string

optional

A URL of a publicly-accessible webpage for this product.

billing_scheme

enum<string>

optional

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

Allowed values:

per_unittiered

lookup_key

string

optional

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

recurring

object

optional

The recurring components of a price such as interval and usage_type.

interval

enum<string>

required

Specifies billing frequency. Either day, week, month or year.

Allowed values:

daymonthweekyear

interval_count

string

optional

The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

usage_type

enum<string>

optional

Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed

Allowed value:

licensed

Example

{
  "currency": "string",
  "product": "string",
  "unit_amount": "string",
  "active": "string",
  "metadata": {},
  "nickname": "string",
  "product_data": {
    "active": true,
    "description": "string",
    "images": [
      "string"
    ],
    "metadata": {},
    "name": "string",
    "url": "string"
  },
  "billing_scheme": "per_unit",
  "lookup_key": "string",
  "recurring": {
    "interval": "day",
    "interval_count": "string",
    "usage_type": "licensed"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apitest.wooshpay.com/v1/prices?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues' \
--data-raw ''

Responses

🟢200OK

application/json

Body

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 lowercase.

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.

recurring

object

optional

The recurring components of a price

interval

enum<string>

required

The frequency at which a subscription is billed. One of day, week, month or year.

Allowed values:

dayweekmonthyear

interval_count

integer

optional

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

usage_type

enum<string>

optional

Configures how the quantity per period should be determined.

Allowed value:

licensed

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,
  "recurring": {
    "interval": "day",
    "interval_count": 0,
    "usage_type": "licensed"
  }
}

Modified at 2024-05-29 12:07:42

List all products

Retrieve a price