MOmonei
Prices

Create Price

Changed on

Creates a price of a product.

The product must be in your account. It can be archived.

Rules:

  • currency defaults to the default currency of your account, else EUR
  • minute and hour intervals are accepted in test mode only
  • The billing period (intervalCount intervals) cannot be longer than one year
  • trialPeriodDays is from 1 to 1825

The amount, the currency and the billing period cannot change later. To change them, create a new price.

post/prices

Request

Request body

productIdstring uuid required

The product of the price. It cannot change after the price is created.

unitAmountinteger required

The amount charged for each billing period. A positive integer in the smallest currency unit (for example, 1990 cents to charge 19.90 EUR).

currencystring

Three-letter ISO currency code, in uppercase. Must be a supported currency.

typestring

How the price bills. RECURRING is the only value today, and the default. Treat the set as open: more values can be added later.

activeboolean

Whether the price is active. An inactive price cannot start a subscription, and a subscription cannot switch to it. Prices are never deleted: set active to false to archive one. Subscriptions that already use it keep their copy of its values.

nicknamestring

An internal label of the price. Buyers never see it.

metadataMetadata

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

Example request

{
  "productId": "8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60",
  "unitAmount": 1990,
  "currency": "EUR",
  "type": "RECURRING",
  "recurring": {
    "interval": "month",
    "intervalCount": 1,
    "trialPeriodDays": 7
  },
  "active": true,
  "nickname": "Monthly",
  "metadata": {
    "systemId": "12345"
  }
}

Response

A price object

idstring uuid required

Unique identifier for the price.

productIdstring uuid required

The product of the price. It cannot change after the price is created.

currencystring required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

unitAmountinteger required

The amount charged for each billing period. A positive integer in the smallest currency unit (for example, 1990 cents to charge 19.90 EUR).

typestring required

How the price bills. RECURRING is the only value today, and the default. Treat the set as open: more values can be added later.

activeboolean required

Whether the price is active. An inactive price cannot start a subscription, and a subscription cannot switch to it. Prices are never deleted: set active to false to archive one. Subscriptions that already use it keep their copy of its values.

nicknamestring

An internal label of the price. Buyers never see it.

metadataMetadata

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

createdAtinteger required

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

updatedAtinteger

Time at which the resource updated last time. Measured in seconds since the Unix epoch.

Example response

{
  "id": "3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13",
  "productId": "8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60",
  "currency": "EUR",
  "unitAmount": 1990,
  "type": "RECURRING",
  "recurring": {
    "interval": "month",
    "intervalCount": 1,
    "trialPeriodDays": 7
  },
  "active": true,
  "nickname": "Monthly",
  "metadata": {
    "systemId": "12345"
  },
  "createdAt": 1636366897,
  "updatedAt": 1636366897
}

Changes