Skip to main content

CreatePriceInput

Input for createPrice.

input CreatePriceInput {
productId: ID!
unitAmount: Int!
currency: Currencies
type: String
recurring: PriceRecurringInput
taxBehavior: String
active: Boolean
nickname: String
metadata: [KeyValueInput!]
}

Fields​

CreatePriceInput.productId ● ID! non-null scalar​

ID of the product of the price.

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

CreatePriceInput.currency ● Currencies enum​

Three-letter ISO 4217 currency code. Defaults to the default currency of the account, else EUR.

CreatePriceInput.type ● String scalar​

How the price bills: RECURRING (default) or ONE_TIME.

CreatePriceInput.recurring ● PriceRecurringInput input​

Billing period of the price. Required for a RECURRING price, refused for a ONE_TIME price.

CreatePriceInput.taxBehavior ● String scalar​

INCLUSIVE or EXCLUSIVE: whether unitAmount holds the tax of the product's tax rate. No value means INCLUSIVE. Cannot change later.

CreatePriceInput.active ● Boolean scalar​

Whether the price is active. Defaults to true.

CreatePriceInput.nickname ● String scalar​

Internal label of the price, up to 100 characters.

CreatePriceInput.metadata ● [KeyValueInput!] list input​

Key/value metadata. Each key holds up to 50 characters and each value up to 500.

Member Of​

createPrice mutation