Skip to navigation
API ReferenceCompany

Get Upcoming Renewal

Returns what your company’s next billing cycle renews into and when it will be charged. Not paginated, no parameters. Only for companies on SalaryBox’s current pricing. Does not need Payroll Pro.

  • data is null when the company has no recurring payment set up.
  • This shows what auto-renew will charge next. upcoming_renewal in Get Company Subscription shows a cycle that is already paid for.
  • Returns 503 "Upcoming renewal details are temporarily unavailable, please try again" when SalaryBox’s payments service cannot be reached.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Response

The next renewal, or null data when no recurring payment is set up.

messagestring
statusboolean
dataobject or null

null when the company has no recurring payment set up.

Errors

403
Forbidden Error
503
Service Unavailable Error