Skip to main content

Price

How much a product costs and how often it bills. Pass its id as priceId to createSubscription or updateSubscription: the subscription copies unitAmount, currency and recurring, so a later change to the price never changes an existing subscription. Only active, nickname and metadata can change; to change the amount or the billing period, create a new price.

type Price {
  id: ID!
  productId: ID!
  currency: Currencies!
  unitAmount: Int!
  type: String!
  recurring: PriceRecurring
  active: Boolean!
  nickname: String
  metadata: [KeyValueItem!]
  createdAt: AWSTimestamp!
  updatedAt: AWSTimestamp
}

Fields​

Price.id ● ID! non-null scalar​

Price ID.

Price.productId ● ID! non-null scalar​

ID of the product of the price.

Price.currency ● Currencies! non-null enum​

Three-letter ISO 4217 currency code.

Price.unitAmount ● Int! non-null scalar​

Amount charged for each billing period, as a positive integer in the smallest currency unit.

Price.type ● String! non-null scalar​

How the price bills. Today always RECURRING; more values may be added.

Price.recurring ● PriceRecurring object​

Billing period of a RECURRING price.

Price.active ● Boolean! non-null scalar​

Whether the price is active. An inactive price cannot start or switch a subscription. A price is archived with active: false; prices are never deleted.

Price.nickname ● String scalar​

Internal label of the price, up to 100 characters.

Price.metadata ● [KeyValueItem!] list object​

Key/value metadata that the merchant set.

Price.createdAt ● AWSTimestamp! non-null scalar​

Creation time. Measured in seconds since the Unix epoch.

Price.updatedAt ● AWSTimestamp scalar​

Last update time. Measured in seconds since the Unix epoch.

Returned By​

createPrice mutation ● price query ● updatePrice mutation

Member Of​

PricesConnection object