Utilize esta função para obter um plano cadastrado na plataforma. Planos são utilizados para definir a base das assinaturas. Uma nova assinatura herdará a maioria dos atributos do plano respectivo no momento de sua criação. Se um plano for alterado, assinaturas associadas não serão atualizadas automaticamente.
Duração do plano
A duração do plano é definida a partir da combinação de 3 atributos: interval, interval_count e billing_cycles. Com esses atributos é possível gerar qualquer combinação possível de periodicidade e duração. Exemplos:
| Duração | interval | interval_count | billing_cycles |
|---|---|---|---|
| Plano mensal com duração ilimitada | 'months' | 1 | (nulo) |
| Plano mensal com duração de 3 meses | 'months' | 1 | 3 |
| Plano semanal com duração de 3 meses | 'days' | 7 | 12 |
| Plano anual com duração ilimitada | 'months' | 12 | (nulo) |
| Plano mensal com duração de 1 ano | 'months' | 12 | 1 |
Calcula-se a duração de um período multiplicando a duração do intervalo (interval) pelo número de intervalos (interval_count). O número máximo de períodos é definido pelo atributo billing_cycles. Através destas combinações é possível gerar planos quinzenais, mensais, semanais, semestrais, trimestrais, anuais, etc.
O atributo interval_name no retorno exibe o nome do período gerado a partir dessas configurações.
Precificação
Um plano não possui nenhuma informação relacionada ao preço. O valor de uma assinatura será calculado a partir dos produtos associados ao plano. Os produtos associados ao plano estão representados no atributo plan_items.
Cobrança
A data da geracão da cobrança de um período deve ser configurada usando os atributos billing_trigger_type, que define a orientação da data de cobrança, e billing_trigger_day, que define o dia da cobrança. Exemplos:
| Cobrança | billing_trigger_type | billing_trigger_day |
|---|---|---|
| Exatamente no início do período | 'beginning_of_period' | 0 |
| Cinco dias após o início do período | 'beginning_of_period' | 5 |
| Dez dias antes do término do período | 'end_of_period' | -10 |
| Um dia após o término do período | 'end_of_period' | 1 |
| Exatamento no dia 20 de cada mês | 'day_of_month' | 20 |
É importante observar que o tipo de cobrança 'day_of_month' só pode ser usado em planos mensais.