Subscription.php 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <?php
  2. class ChargeBee_Subscription extends ChargeBee_Model
  3. {
  4. protected $allowed = array('id', 'customerId', 'currencyCode', 'planId', 'planQuantity', 'planUnitPrice',
  5. 'setupFee', 'billingPeriod', 'billingPeriodUnit', 'planFreeQuantity', 'status', 'startDate','trialStart', 'trialEnd', 'currentTermStart', 'currentTermEnd', 'nextBillingAt', 'remainingBillingCycles','poNumber', 'createdAt', 'startedAt', 'activatedAt', 'pauseDate', 'resumeDate', 'cancelledAt','cancelReason', 'affiliateToken', 'createdFromIp', 'resourceVersion', 'updatedAt', 'hasScheduledChanges','paymentSourceId', 'autoCollection', 'dueInvoicesCount', 'dueSince', 'totalDues', 'mrr', 'exchangeRate','baseCurrencyCode', 'addons', 'coupon', 'coupons', 'shippingAddress', 'referralInfo', 'invoiceNotes','metaData', 'deleted');
  6. # OPERATIONS
  7. #-----------
  8. public static function create($params, $env = null, $headers = array())
  9. {
  10. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions"), $params, $env, $headers);
  11. }
  12. public static function createForCustomer($id, $params, $env = null, $headers = array())
  13. {
  14. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers);
  15. }
  16. public static function all($params = array(), $env = null, $headers = array())
  17. {
  18. return ChargeBee_Request::sendListRequest(ChargeBee_Request::GET, ChargeBee_Util::encodeURIPath("subscriptions"), $params, $env, $headers);
  19. }
  20. public static function subscriptionsForCustomer($id, $params = array(), $env = null, $headers = array())
  21. {
  22. return ChargeBee_Request::send(ChargeBee_Request::GET, ChargeBee_Util::encodeURIPath("customers",$id,"subscriptions"), $params, $env, $headers);
  23. }
  24. public static function retrieve($id, $env = null, $headers = array())
  25. {
  26. return ChargeBee_Request::send(ChargeBee_Request::GET, ChargeBee_Util::encodeURIPath("subscriptions",$id), array(), $env, $headers);
  27. }
  28. public static function retrieveWithScheduledChanges($id, $env = null, $headers = array())
  29. {
  30. return ChargeBee_Request::send(ChargeBee_Request::GET, ChargeBee_Util::encodeURIPath("subscriptions",$id,"retrieve_with_scheduled_changes"), array(), $env, $headers);
  31. }
  32. public static function removeScheduledChanges($id, $env = null, $headers = array())
  33. {
  34. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"remove_scheduled_changes"), array(), $env, $headers);
  35. }
  36. public static function removeScheduledCancellation($id, $params = array(), $env = null, $headers = array())
  37. {
  38. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"remove_scheduled_cancellation"), $params, $env, $headers);
  39. }
  40. public static function removeCoupons($id, $params = array(), $env = null, $headers = array())
  41. {
  42. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"remove_coupons"), $params, $env, $headers);
  43. }
  44. public static function update($id, $params = array(), $env = null, $headers = array())
  45. {
  46. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id), $params, $env, $headers);
  47. }
  48. public static function changeTermEnd($id, $params, $env = null, $headers = array())
  49. {
  50. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"change_term_end"), $params, $env, $headers);
  51. }
  52. public static function cancel($id, $params = array(), $env = null, $headers = array())
  53. {
  54. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"cancel"), $params, $env, $headers);
  55. }
  56. public static function reactivate($id, $params = array(), $env = null, $headers = array())
  57. {
  58. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"reactivate"), $params, $env, $headers);
  59. }
  60. public static function addChargeAtTermEnd($id, $params, $env = null, $headers = array())
  61. {
  62. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"add_charge_at_term_end"), $params, $env, $headers);
  63. }
  64. public static function chargeAddonAtTermEnd($id, $params, $env = null, $headers = array())
  65. {
  66. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"charge_addon_at_term_end"), $params, $env, $headers);
  67. }
  68. public static function chargeFutureRenewals($id, $params = array(), $env = null, $headers = array())
  69. {
  70. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"charge_future_renewals"), $params, $env, $headers);
  71. }
  72. public static function importSubscription($params, $env = null, $headers = array())
  73. {
  74. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions","import_subscription"), $params, $env, $headers);
  75. }
  76. public static function importForCustomer($id, $params, $env = null, $headers = array())
  77. {
  78. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("customers",$id,"import_subscription"), $params, $env, $headers);
  79. }
  80. public static function overrideBillingProfile($id, $params = array(), $env = null, $headers = array())
  81. {
  82. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"override_billing_profile"), $params, $env, $headers);
  83. }
  84. public static function delete($id, $env = null, $headers = array())
  85. {
  86. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"delete"), array(), $env, $headers);
  87. }
  88. public static function pause($id, $params = array(), $env = null, $headers = array())
  89. {
  90. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"pause"), $params, $env, $headers);
  91. }
  92. public static function resume($id, $params = array(), $env = null, $headers = array())
  93. {
  94. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"resume"), $params, $env, $headers);
  95. }
  96. public static function removeScheduledPause($id, $env = null, $headers = array())
  97. {
  98. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"remove_scheduled_pause"), array(), $env, $headers);
  99. }
  100. public static function removeScheduledResumption($id, $env = null, $headers = array())
  101. {
  102. return ChargeBee_Request::send(ChargeBee_Request::POST, ChargeBee_Util::encodeURIPath("subscriptions",$id,"remove_scheduled_resumption"), array(), $env, $headers);
  103. }
  104. }
  105. ?>