Crear plan

Crear planServer-sideAdmin

post/projects/{project_id}/subscriptions/plans

Crea un plan de suscripción.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID de proyecto.

Request Body schema: application/json

required

object

Nombre del plan. El valor se compone de pares de "localization":"plan name".

ar	string Árabe.
bg	string Búlgaro.
cn	string Chino (simplificado).
cs	string Checo.
de	string Alemán.
en	string Inglés.
es	string Español.
fr	string Francés.
he	string Hebreo.
it	string Italiano.
ja	string Japonés.
ko	string Coreano.
pl	string Polaco.
pt	string Portugués.
ro	string Rumano.
ru	string Ruso.
th	string Tailandés.
tr	string Turco.
tw	string Chino (tradicional).
vi	string Vietnamita.

required

object

Datos de facturación.

required

object

Periodo de facturación.

value required	integer Número de unidades de tiempo. El valor depende del tipo de parámetro y puede ser: - desde 1 hasta 366, si `type` es `day` - desde 1 hasta 12, si `type` es `month`; 0 si `type` es `lifetime`
type required	string Unidades de tiempo. Puede ser `day`, `month` o `lifetime`. Enum: "day" "month" "lifetime"

amount

number <float>

Importe de facturación.

currency

string

Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.

Array of objects

Lista de precios en diferentes monedas.

Array

amount required	number <float> Importe de facturación.
currency required	string Moneda de la compra. Código de moneda de tres letras de conformidad con la norma ISO 4217.
setup_fee	number <float> En la primera factura, se cobra una tarifa única de configuración.

object

Detalles del reintento de facturación.

value

required

integer

Número de reintentos de facturación.

object

Descripción del plan. El valor se compone de pares de "localization":"plan description".

ar	string Árabe.
bg	string Búlgaro.
cn	string Chino (simplificado).
cs	string Checo.
de	string Alemán.
en	string Inglés.
es	string Español.
fr	string Francés.
he	string Hebreo.
it	string Italiano.
ja	string Japonés.
ko	string Coreano.
pl	string Polaco.
pt	string Portugués.
ro	string Rumano.
ru	string Ruso.
th	string Tailandés.
tr	string Turco.
tw	string Chino (tradicional).
vi	string Vietnamita.

object

Datos de finalización de la suscripción.

value required	integer Periodo de validez.
type required	string Unidad de tiempo. Puede ser `day` o `month`. Enum: "day" "month"

external_id

string

ID externo del plan (32 caracteres).

object

Detalles del periodo de gracia.

value required	integer Número de unidades de tiempo.
type required	string Unidad de tiempo. Puede ser `day`. Value: "day"

group_id

string

ID del grupo al que está vinculado el plan.

integer

ID del plan de suscripción.

project_id

integer

ID de proyecto.

refund_period

integer

Periodo de tiempo durante el cual el usuario puede reembolsar el pago de un plan de suscripción (en días).

object

value

string

Estado del plan de suscripción.

Enum: "active" "disabled"

tags

Array of strings

Etiquetas del plan.

object

Detalles del periodo de prueba.

value required	integer Número de unidades de tiempo.
type required	string Unidad de tiempo. Puede ser `day`. Value: "day"

Responses

201

Creado.

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
}