Criar Plano

Criar PlanoServer-sideAdmin

post/projects/{project_id}/subscriptions/plans

Crie um plano de assinatura.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID de projeto.

Request Body schema: application/json

required

object

Nome do plano. O valor consiste de pares "localization":"plan name".

ar	string Árabe.
bg	string Búlgaro.
cn	string Chinês (Simplificado).
cs	string Tcheco.
de	string Alemão.
en	string Inglês.
es	string Espanhol.
fr	string Francês.
he	string Hebreu.
it	string Italiano.
ja	string Japonês.
ko	string Coreano.
pl	string Polonês.
pt	string Português.
ro	string Romeno.
ru	string Russo.
th	string Tailandês.
tr	string Turco.
tw	string Chinês (Tradicional).
vi	string Vietnamita.

required

object

Dados de cobrança.

required

object

Período de cobrança.

value required	integer Quantidade de unidades de tempo. O valor depende do parâmetro do tipo e pode ser: - entre 1 e 366, se `type` for `day` - entre 1 e 12, se `type` for `month` - 0 se `type` for `lifetime`
type required	string Unidade de tempo. Pode ser `day`, `month` ou `lifetime`. Enum: "day" "month" "lifetime"

amount

number <float>

Quantia da cobrança.

currency

string

Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.

Array of objects

Lista de preços em moedas diferentes.

Array

amount required	number <float> Quantia da cobrança.
currency required	string Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.
setup_fee	number <float> Cobrança única de configuração realizada como parte da primeira fatura.

object

Dados de tentativa de cobrança.

value

required

integer

Quantidade de tentativas de cobrança.

object

Descrição do plano. O valor consiste de pares "localization":"plan description".

ar	string Árabe.
bg	string Búlgaro.
cn	string Chinês (Simplificado).
cs	string Tcheco.
de	string Alemão.
en	string Inglês.
es	string Espanhol.
fr	string Francês.
he	string Hebreu.
it	string Italiano.
ja	string Japonês.
ko	string Coreano.
pl	string Polonês.
pt	string Português.
ro	string Romeno.
ru	string Russo.
th	string Tailandês.
tr	string Turco.
tw	string Chinês (Tradicional).
vi	string Vietnamita.

object

Dados de término da assinatura.

value required	integer Tempo de validade.
type required	string Unidade de tempo. Pode ser `day` ou `month`. Enum: "day" "month"

external_id

string

Planejar ID externo (32 caracteres).

object

Dados do período de carência.

value required	integer Quantidade de unidades de tempo.
type required	string Unidade de tempo. Pode ser `day`. Value: "day"

group_id

string

ID de grupo ao qual o plano está vinculado.

integer

ID de plano de assinatura.

project_id

integer

ID de projeto.

refund_period

integer

Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias).

object

value

string

Status do plano de assinatura.

Enum: "active" "disabled"

tags

Array of strings

Rótulos do plano.

object

Dados do período de teste.

value required	integer Quantidade de unidades de tempo.
type required	string Unidade de tempo. Pode ser `day`. Value: "day"

Responses

201

Criado.

Request samples

application/json

{"billing_retry": {"value": 1
},
"charge": {"amount": 10,
"currency": "USD",
"period": {"type": "month",
"value": 1
},
"prices": [{"amount": 8,
"currency": "EUR",
"setup_fee": 1.5
},
{"amount": 1000,
"currency": "JPY",
"setup_fee": 2.5
}
]
},
"description": {"en": "2x more experience!"
},
"expiration": {"type": "day",
"value": null
},
"external_id": "exp",
"grace_period": {"type": "day",
"value": 2
},
"name": {"en": "Experience boost"
},
"refund_period": null,
"status": {"value": "active"
},
"trial": {"type": "day",
"value": 7
}
}

Response samples

application/json

{"external_id": "exp",
"plan_id": 241082
}