API upgrades
Keep track of changes and deprecation to the Hyperline API
November 6, 2024
- Added
/v1/customers/{id}/unarchive
PUT endpoint - Added
/v1/invoices/{id}
PATCH endpoint - Added
/v1/subscriptions/{id}/activate
POST endpoint
October 23, 2024
- Added
/v1/customers/{id}/payment-methods
GET endpoint - Added
/v1/customers/{id}/payment-methods/{paymentMethodId}
GET, DELETE endpoints
October 8, 2024
- Added
/v1/companies
POST endpoint
August 21, 2024
- Added
custom_property.created
,custom_property.updated
,custom_property.deleted
,custom_property.value_created
,custom_property.value_updated
,bank_account.created
,bank_account.deleted
webhooks
August 20, 2024
- Added
/v1/taxes/rates
GET endpoint - Added
/v1/taxes/rates/{id}
GET endpoint - Added
Product.accounting
on/v1/products/{id}
GET, POST, PUT endpoints - Added
Invoice.line_items[].tax_rate_id
on/v1/invoices
GET endpoint - Added
Invoice.line_items[].tax_rate_id
on/v1/invoices/{id}
GET endpoint - Added
Customer.custom_payment_delay
on/v1/customers
GET endpoint - Added
Customer.custom_payment_delay
on/v1/customers/{id}
GET, POST, PUT endpoints
August 12, 2024
- Added
Subscription.custom_properties
on/v2/subscriptions
GET, POST endpoints - Added
Subscription.custom_properties
on/v2/subscriptions/{id}
GET, PUT endpoints
August 7, 2024
- Added
/v1/quotes/{id}/sign
POST endpoint - Added
/v1/invoices/{id}/void
POST endpoint
July 30, 2024
- Added
Customer.timezone
on/v1/customers
GET, POST endpoints - Added
Customer.timezone
on/v1/customers/{id}
GET, PUT endpoints Subscription.payment_method_strategy
is now optional on/v2/subscriptions
POST endpoint
July 3, 2024
-
Added
/v1/organisations/{id}
GET endpoint -
Added
/v1/organisations/{id}
PATCH endpoint -
Added
Customer.organisation_id
andCustomer.organisation_invoicing
on/v1/customers
POST endpoint -
Added
Customer.organisation_id
andCustomer.organisation_invoicing
on/v1/customers/{id}
GET, PUT endpoints -
Added
Subscription.contract_start
andSubscription.contract_end
on/v2/subscriptions/*
endpoints -
Added
Subscription.products[].attached_at
andSubscription.products[].detached_at
on/v2/subscriptions/*
endpoints -
Added
/v1/subscriptions/{id}/reinstate
POST endpoint -
Added
update_prices
SubscriptionUpdate.type
on/v1/subscriptions/{id}/update
POST endpoint -
Added
/v1/subscriptions/{id}/update-many
POST endpoint -
Major
Deprecation warning
- Deprecating
Subscription.starts_at
in favor ofSubscription.contract_start
- Deprecating
-
Major
Planned for September 1, 2024
- Removing
SubscriptionUpdate.payload.billing_item_ids
in favor ofSubscriptionUpdate.payload.product_ids
foradd_coupon
update type - Removing
add_item
SubscriptionUpdate.type
in favor ofadd_product
- Removing
remove_item
SubscriptionUpdate.type
in favor ofremove_product
- Removing
June 26, 2024
- Added
/v1/quotes
POST endpoint - Added
/v1/quotes/{id}/download
GET endpoint - Added
/v1/quotes/{id}/send
POST endpoint - Added
/v1/quotes/{id}/void
POST endpoint
June 12, 2024
- Add
Customer.custom_properties
on/v1/customers
GET endpoint
May 27, 2024
- Added
/v1/quotes
GET endpoint - Added
/v1/quotes/{id}
GET endpoint - Added
/v1/quotes/{quoteId}/files/{id}/download
GET endpoint
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
Was this page helpful?