Skip to main content

CreatePriceInput

Input for createPrice.

input CreatePriceInput {
  productId: ID!
  unitAmount: Int!
  currency: Currencies
  type: String
  recurring: PriceRecurringInput!
  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 charged for each billing period, as a positive integer in the smallest currency unit.

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. Defaults to RECURRING, the only value accepted today.

CreatePriceInput.recurring ● PriceRecurringInput! non-null input​

Billing period of the price.

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