API documentation
API upgrades
Keep track of changes and deprecation to the Hyperline API
April 2, 2024
- Major Removed deprecated subscription endpoints
- Removed
GET /v1/subscriptions
in favor ofGET /v2/subscriptions
- Removed
GET /v1/subscriptions/{id}
in favor ofGET /v2/subscriptions/{id}
- Removed
POST /v1/subscriptions
in favor ofPOST /v2/subscriptions
- Removed
GET /v1/billing-plans/{id}
in favor ofGET /v1/plans/{id}
- Removed
GET /v1/billing-scenarios
- Removed
GET /v1/billing-scenarios/{id}
- Removed
March 6, 2024
- Added
/v1/subscriptions/{id}/pause
PUT endpoint - Added
/v1/subscriptions/{id}/reactivate
PUT endpoint - Added
/v1/subscriptions/refresh
POST endpoint
March 5, 2024
- Added
/v1/webhooks/endpoints
GET, POST endpoints - Added
/v1/webhooks/endpoints/{id}
GET, PUT, DELETE endpoints
March 1, 2024
- Major Removed unit concept on wallets (only money pocket) in favor of credit-type products to manage credit units.
- Removed
WalletBalance.units
- Removed
WalletSettings.unit_credit_prices
- Removed
WalletTransaction.units
andWalletTransaction.transaction_id
- Removed
February 28, 2024
- Major Removed unique current customer subscription in favor of subscriptions array.
- Removed
Customer.current_subscription_id
on/v1/customers
GET endpoint - Removed
Customer.current_subscription
on/v1/customers/{id}
GET endpoint
- Removed
February 20, 2024
- Added
Customer.type
on/v1/customers
GET, POST and PUT endpoints - Added
Customer.invoice_emails
on/v1/customers
GET, POST and PUT endpoints - Added
Customer.vat_rate_custom
on/v1/customers
GET, POST and PUT endpoints - Added
external
option onCustomer.payment_method_type
on/v1/customers
POST and PUT endpoints
February 16, 2024
-
Major
Planned for April 1, 2024
- Removing
Customer.country
in favor ofCustomer.billing_address.country
- Removing
GET /v1/subscriptions
in favor ofGET /v2/subscriptions
- Removing
GET /v1/subscriptions/{id}
in favor ofGET /v2/subscriptions/{id}
- Removing
POST /v1/subscriptions
in favor ofPOST /v2/subscriptions
- Removing
-
Major
Planned for February 28, 2024
- Removing
Customer.current_subscription_id
on/v1/customers
GET endpoint in favor ofCustomer.subscriptions
- Removing
Customer.current_subscription
on/v1/customers/{id}
GET endpoint in favor ofCustomer.subscriptions
- Removing