Skip to main content
POST
Criar um plano de assinatura

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

productId
string
required

Identificador do produto dono da oferta.

Minimum string length: 1

Body

application/json
title
string
required

Nome do plano no checkout.

Required string length: 2 - 200
price
integer
required

Valor de cada cobrança, em centavos.

Required range: x >= 500
frequency
enum<string>
required

Intervalo entre as cobranças do plano.

Available options:
weekly,
monthly,
bimonthly,
quarterly,
semiannual,
annual
renewalType
enum<string>
required

Renova até o cancelamento ou para depois de N cobranças.

Available options:
until_cancelled,
fixed_charges
maxCharges
integer

Número de cobranças quando renewalType é fixed_charges.

Required range: x > 0
hasDifferentFirstPrice
boolean
default:false

A primeira cobrança tem valor próprio.

firstChargePrice
integer

Valor da primeira cobrança, em centavos.

Required range: x >= 500
admissionFeePrice
integer

Taxa de adesão somada só à primeira cobrança, em centavos.

Required range: x > 0
promotional
boolean

Marca o plano como promoção.

compareAtPrice
integer | null

Preço "de" riscado, em centavos.

Required range: x > 0
expiresAt
string<date-time> | null

Momento em que o plano para de aceitar novas assinaturas.

Response

Plano de assinatura criado.

Plano de assinatura criado.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required