Usage Based Billing

[bhelx]

This is a feature that is not yet enabled on all sites and this PR is still a WIP.

This introduces some new resources and updates to current resources to
support the usage based billing (metered billing) feature.

https://docs.recurly.com/docs/usage-based-billing

Merged Ruby Version: recurly/recurly-client-ruby#237

Testing

$units = array();
foreach(Recurly_MeasuredUnitList::get() as $unit) {
  $units[$unit->name] = $unit;
}

if (isset($units['email'])) {
  $unit = $units['email'];
}
else {
  $unit = new Recurly_MeasuredUnit();
  $unit->name = 'email';
  $unit->display_name = 'email';
  $unit->description = 'An email';
  $unit->create();
}

$plan_code = uniqid();

$plan = new Recurly_Plan();
$plan->plan_code = $plan_code;
$plan->name = $plan_code;
$plan->unit_amount_in_cents->addCurrency('USD', 1000); // USD 10.00 month
$plan->plan_interveral_length = 1;
$plan->plan_interveral_unit = 'months';
$plan->create();

print "Plan: $plan\n\n";

$add_on = new Recurly_Addon();
$add_on->plan_code = $plan_code;
$add_on->add_on_code = 'marketing_emails';
$add_on->name = 'Marketing Emails';
$add_on->unit_amount_in_cents->addCurrency('USD', 5);
$add_on->measured_unit_id = $unit->id;
$add_on->add_on_type = 'usage';
$add_on->usage_type = 'price';
$add_on->optional = true;

$add_on->create();

print "AddOn: $add_on\n\n";

$subscription = new Recurly_Subscription();
$subscription->currency = 'USD';
$subscription->plan_code = $plan_code;
$subscription->collection_method = 'manual';

$account = new Recurly_Account();
$account->account_code = 'usageaccount';
$subscription->account = $account;

$addon = new Recurly_SubscriptionAddOn();
$addon->add_on_code = 'marketing_emails';

$subscription->subscription_add_ons = array($addon);

$subscription->create();

print "Subscription: $subscription\n\n";

sleep(1);

$usage = $subscription->buildUsage('marketing_emails');

print $usage;

$usage->amount = 100;
$usage->merchant_tag = "100 emails";
$usage->recording_timestamp = new DateTime();
sleep(3);
$usage->usage_timestamp = new DateTime();

$usage->create();

$usages = $subscription->usages('marketing_emails');

print "Usages: \n";

print count($usages);
foreach ($usages as $usage) {
  print $usage->merchant_tag . "\n";
}

// usages optionally takes params

// billing_status ["all" || "unbilled" || "billed"]
// datetime_type ["usage" || "recording"]
$params = array(
  "billing_status" => "all",
  "datetime_type" => "usage",
  #start_datetime: datetime,
  #end_datetime: datetime,
);

$usages = $subscription->usages('marketing_emails', $params);

print count($usages);
foreach ($usages as $usage) {
  print $usage->merchant_tag . "\n";
}

[drewish]

They can set the id?

[drewish]

Should this be getting deleted?

[drewish]

Let's go ahead and check the name, display_name and description values as well.

[drewish]

Now that this is getting switched to lowecase you want to go ahead and down case it here too?

[drewish]

So aside from that case change this looks good. We can do that here or in a followup.

[bhelx]

Okay, updated

[drewish]

sorry should have called this one out too

[bhelx]

Thanks, missed that too

[drewish]

+1