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 the amount, currency and recurring, so a later change to the price never changes an existing subscription. The amount is unitAmount, plus the tax of the product's tax rate for an EXCLUSIVE price. 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
taxBehavior: String
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 of the price, as a positive integer in the smallest currency unit: for each billing period of a RECURRING price, once for a ONE_TIME price. Without tax for an EXCLUSIVE price.

Price.type ● String! non-null scalar​

How the price bills: RECURRING or ONE_TIME. More values may be added. Only a RECURRING price can start or switch a subscription.

Price.recurring ● PriceRecurring object​

Billing period of a RECURRING price. null for a ONE_TIME price.

Price.taxBehavior ● String scalar​

How the tax of the product's tax rate applies: INCLUSIVE (unitAmount holds the tax) or EXCLUSIVE (the tax is added to unitAmount). More values may be added. No value means INCLUSIVE.

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