Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HitPay Recurring Billing API

The Recurring Billing API from HitPay — 5 operation(s) for recurring billing.

HitPay Recurring Billing API is one of 24 APIs that HitPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Recurring Billing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.1.1, at version 1.0.

Requests are made against 2 base URLs: https://api.hit-pay.com, https://api.sandbox.hit-pay.com.

9 operations 5 paths 4 schemas 2 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0
Base URL
https://api.hit-pay.com/v1
Resource Areas
1

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Recurring Billing 9
POST
/v1/recurring-billing
Create Recurring Billing
create-a-recurring-billing 1 param body → 200422
GET
/v1/recurring-billing
Get All Recurring Billing
get-all-recurring-billing 5 params → 200
GET
/v1/recurring-billing/{recurring_billing_id}
Get saved card details
get-saved-card-details 2 params → 200404
PUT
/v1/recurring-billing/{recurring_billing_id}
Update Recurring Billing
update-recurring-billing 2 params body → 200422
DELETE
/v1/recurring-billing/{recurring_billing_id}
Delete Recurring Billing
delete-a-recurring-billing-detail 2 params → 200404
POST
/recurring-billing
Create a recurring billing subscription
createRecurringBilling body → 201
GET
/recurring-billing/{id}
Get a recurring billing subscription
getRecurringBilling 1 param → 200
DELETE
/recurring-billing/{id}
Cancel a recurring billing subscription
cancelRecurringBilling 1 param → 200
POST
/charge/{recurring_billing_id}
Charge a saved card
chargeRecurringBilling 1 param body → 201

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RecurringBillingCreate (9 properties), RecurringBilling (8 properties), Charge (5 properties), ChargeCreate (2 properties). Each schema is shown below with its type and property counts.

RecurringBilling
object
8 properties
ChargeCreate
object
2 properties 2 required
Charge
object
5 properties
RecurringBillingCreate
object
9 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hitpay-recurring-billing-api-openapi.yml Raw ↑

Other APIs HitPay publishes across the network.

HitPay Account Status API
HitPay Balances API
HitPay Beneficiaries API
HitPay Charge API
HitPay Charges API
HitPay Customers API
HitPay Invoices API
HitPay Notifications API
HitPay Orders API
HitPay Payment Requests API
HitPay Product Category API
HitPay Products API