EZezypay

Update a plan

Changed on

The API Endpoint allows integrators to update details of a plan. Any changes actioned on the plan, will only be effective for subscriptions created after the update.

Existing subscriptions will not be affected and remain grandfathered at terms agreed previously when subscribing to the plan.

NOTE: It a good practice to use the "accountingCode" to provide a grouping for the plan. This will automatically appear in the invoice generated by Ezypay based on your frequency settings.

put/billing/plans/{planId}

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/plans/{planId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

planIdstring required

Identifier of the plan to update.

Headers

merchantstring required

Merchant ID

Request body

namestring

Plan name. Max of 50 characters.

memostring

Brief memo of the plan. Max of 50 characters.

statusstring

Current state of the plan. Supported values are: active - Customers can subscribe to the plan. inactive - Customers are unable to subscribe to the plan.

intervalUnitstring

Specifies frequency of billing. Can be day, week or month. If no value is provided, the default value is week.

intervalinteger

Number to be specified as interval to manipulate billing frequency. For example interval=2 and intervalUnit=week would means billing every 2 weeks. If no value is provided, the default value is 1.

billingStartstring

Specify the rules to auto-calculate default billing start dates for customers subscribed to the plan. Supported values are weekday, day_of_month, and subscription_date. Must be specified with a corresponding billingStartValue. The default value is subscription_date. This means, by default, schedules created from this plan will start on the start date defined in the customer’s subscription. However, if the scheduled start date and today’s date are the same, then the subscription is marked as starting today but schedules are generated the next day.

billingEndstring

Specifies the rules to automate when a subscription ends. Supported values are: ongoing - Default value. Subscriptions created from this plan will have no end date and continue billing on an ongoing basis (until instructions are given to stop billing). amount_collected - Subscriptions will end when a specified amount is collected as defined in billingEndValue. billing_cycles - Subscriptions will end after a specified number of billing cycles as defined in billingEndValue. end_date - Subscriptions will end on specific date. Specify this date when you create a subscription in billingEndValue

firstBillingstring

Specifies the rules to auto-calculate the billing charges for the first scheduled billing. Supported values are: If full_amount = Default value. The first billing will charge the full amount on the subscription as defined in the plan's amount. If prorate = Prorate will be auto-calculated for the first billing in the subscription for the pro-rated period, with full recurring billing amount starting from the next billing cycle.

accountingCodestring

Specify an accounting code to categorise revenue collected from the plan's subscription payment. Max of 50 characters.

Response

200

idstring
statusstring
namestring
memounknown
accountingCodestring
setupPaymentsunknown
intervalUnitstring
intervalinteger
billingStartstring
billingStartValuestring
billingEndstring
billingEndValueunknown
firstBillingstring
recurringBillingDayunknown
metadataunknown
createdOnstring

Example response

{
  "id": "d35f6384-e5af-4eaf-b4c9-d08511a21921",
  "status": "ACTIVE",
  "name": "high_st_monthly_plan",
  "accountingCode": "customer_plan",
  "amount": {
    "currency": "NZD",
    "value": 200
  },
  "intervalUnit": "MONTH",
  "interval": 1,
  "billingStart": "DAY_OF_MONTH",
  "billingStartValue": "1",
  "billingEnd": "ONGOING",
  "firstBilling": "FULL_AMOUNT",
  "failedPaymentHandling": {
    "initialAction": "STOP",
    "autoRetry": true,
    "retryInDays": 3,
    "maximumFailedAttempts": 4
  },
  "createdOn": "2019-04-01T12:55:04.245"
}

Changes