Skip to content
Bruno Barroso edited this page Jul 7, 2017 · 3 revisions

O Plano é semelhante a um produto para o modelo de assinaturas. Um plano contém as configurações que uma assinatura vai seguir, como valor e intervalo de cobrança. Crie os planos que deseja oferecer para os seus clientes assinarem.

Para mais detalhes, clique aqui.

Nova instância da API Planos

$plans 	= $api->plans();

Criar um plano

$data = ["code"=> "plan101",
	 "name"=> "Plano Especial",
	 "description"=> "Descrição do Plano Especial",
	 "amount"=> 990,
	 "setup_fee"=> 500,
	 "max_qty"=> 1,
	 "interval"=> [
		"length"=> 1,
		"unit"=> "MONTH"
	 ],
	"billing_cycles"=> 12,
	"trial"=> [
		"days"=> 30,
		"enabled"=> true,
		"hold_setup_fee"=> true
	],
	"payment_method"=> "CREDIT_CARD"
];

$response = $plans->create($data);

Lista todos os planos

$allPlans = $plans->all();

Consultar detalhes de um plano

$result = $plans->find("plan101");

Ativar um plano

$plans->activate("plan101");

Desativar um plano

$plans->deactivate("plan101");

Atualizar informações de um plano

$data = ["name"=> "Plano Especial Alterado",
	 "description"=> "Descrição do Plano Especial Alterado",
	 "amount"=> 990,
	 "setup_fee"=> 500,
	 "max_qty"=> 1,
	 "interval"=> [
		"length"=> 1,
		"unit"=> "MONTH"
	 ],
	"billing_cycles"=> 6,
	"trial"=> [
		"days"=> 10,
		"enabled"=> true,
		"hold_setup_fee"=> true
	],
	"payment_method"=> "CREDIT_CARD"
];

$response = $plans->update("plan101", $data);
Clone this wiki locally