Keep track of changes and deprecation to the Hyperline API
Subscription.crm_opportunity_id
on /v2/subscriptions
POST endpointSubscription.crm_opportunity_id
on /v2/subscriptions/{id}
PUT endpointreason
on /v1/subscriptions/{id}/cancel
POST endpointSubscription.cancellation_reason
on /v2/subscriptions
GET endpointSubscription.cancellation_reason
on /v2/subscriptions/{id}
GET endpoint/v1/customers/{id}/payment-methods
POST endpointTransaction.provider_name
and Transaction.provider_transaction_id
on /v1/invoices/{id}/transactions
POST endpoint/v1/files
GET, POST endpoints/v1/files/{id}
DELETE endpoint/v1/files/{id}/download
GET endpointInvoice.properties
on /v1/invoices
GET, POST endpointsInvoice.properties
on /v1/invoices/{id}
GET, PATCH endpoints/v1/subscriptions/{id}/renew
POST endpointInvoice.coupons
and Invoice.transactions
on /v1/invoices
GET endpointSubscription.name
on /v2/subscriptions/{subscriptionId}
GET endpointSubscription.name
on /v2/subscriptions
GET endpointSubscription.generate_document
, Subscription.document_name
and Subscription.add_vat_to_document
on /v2/subscriptions
POST endpoint/v1/invoices/{id}/credit-notes
POST endpointInvoice.integrations
on /v1/invoices/{id}
GET endpointCustomer.integrations
on /v1/customers/{id}
GET endpointPaymentMethod.integration
on /v1/customers/{id}/payment-methods/{id}
GET endpointCustomer.providers
in favor of Customer.integrations
/v1/price-configurations
GET endpoint/v1/price-configurations/{id}
DELETE endpointpurchase_order
filter on /v2/subscriptions
GET endpoint/v1/promotion-codes
GET, POST endpoints/v1/promotion-codes/{id}
GET, PATCH, DELETE endpointsSubscription.contract_terms
on /v2/subscriptions/{subscriptionId}
GET endpointSubscription.contract_terms
on /v2/subscriptions
POST endpointQuote.subscription.contract_terms
on /v1/quotes
POST endpointInvoice.bank_account_id
on /v1/invoices/{id}
GET endpointInvoice.bank_account_id
on /v1/invoices/{id}
PATCH endpointInvoice.payment_method_type
on /v1/invoices/{id}
PATCH endpointInvoice.payment_method_id
on /v1/invoices/{id}
PATCH endpointSubscription.billing_cycle_alignment
on /v2/subscriptions
POST endpointInvoice.type
on /v1/invoices
POST endpointInvoice.type
on /v1/invoices/{id}
PATCH endpointInvoice.document_name
on /v1/invoices
POST endpointInvoice.document_name
on /v1/invoices/{id}
PATCH endpointInvoice.tax_scheme
on /v1/invoices
POST endpointInvoice.tax_scheme
on /v1/invoices/{id}
PATCH endpointInvoice.line_items
on /v1/invoices/{id}
PATCH endpointSubscription.trial
on /v2/subscriptions
POST endpointQuote.subscription.trial
on /v1/quotes
POST endpointSubscription.trial_ends_at
and Subscription.trial_delay_first_invoice
in
favor of Subscription.trial
Quote.subscription.trial_ends_at
and Quote.subscription.trial_delay_first_invoice
in favor of Quote.subscription.trial
/v1/invoices/{id}/charge
POST endpointInvoice.transactions[].chargeback
on /v1/invoices/{id}
GET endpointSubscription.phases[].billing_cycle_alignment
on /v2/subscriptions/{subscriptionId}
GET endpointSubscriptionPhase.billing_cycle_alignment
on /v2/subscriptions/{subscriptionId}/phases
GET endpointSubscriptionPhase.billing_cycle_alignment
on /v2/subscriptions/{subscriptionId}/phases/{phaseId}
GET endpointSubscription.phases[].billing_cycle_alignment
on /v2/subscriptions
POST endpointQuote.subscription.phases[].billing_cycle_alignment
on /v1/quotes
POST endpointsubscription.reinstated
webhookPaymentMethod.status
on /v1/customers/{id}/payment-methods
GET endpointPaymentMethod.status
on /v1/customers/{id}/payment-methods/{paymentMethodId}
GET endpointCustomer.price_book_id
on /v1/customers
GET endpointCustomer.price_book_id
on /v1/customers/{id}
GET endpoint/v1/products/{id}/archive
PUT endpoint/v1/products/{id}/unarchive
PUT endpoint/v1/invoices/{id}/transactions
POST endpoint/v1/invoices/{id}/transactions/{transactionId}
DELETE endpointprovider_id
on /v1/customers/providers-bulk-update
POST endpointSubscription.phases
on /v2/subscriptions
POST endpointSubscription.phases
on /v2/subscriptions/{id}
GET endpointInvoice.payment_method_id
on /v1/invoices
POST endpointInvoice.line_items[].tax_rate
on /v1/invoices
POST endpointInvoice.line_items[].product_id
on /v1/invoices
POST endpointSubscription.quote
on /v2/subscriptions/{id}
GET endpoint/v2/subscriptions/{id}/phases
GET endpoint/v2/subscriptions/{id}/phases/{phaseId}
GET endpointSubscription.current_phase_id
on /v2/subscriptions
GET endpointSubscription.current_phase_id
on /v2/subscriptions/{id}
GET endpointQuote.original_subscription_id
on /v1/quotes
GET endpointQuote.original_subscription_id
on /v1/quotes/{id}
GET endpoint/v1/invoices/{id}
DELETE endpoint/v1/customers/{id}/unarchive
PUT endpoint/v1/invoices/{id}
PATCH endpoint/v1/subscriptions/{id}/activate
POST endpoint/v1/customers/{id}/payment-methods
GET endpoint/v1/customers/{id}/payment-methods/{paymentMethodId}
GET, DELETE endpoints/v1/companies
POST endpointcustom_property.created
, custom_property.updated
, custom_property.deleted
, custom_property.value_created
, custom_property.value_updated
, bank_account.created
, bank_account.deleted
webhooks/v1/taxes/rates
GET endpoint/v1/taxes/rates/{id}
GET endpointProduct.accounting
on /v1/products/{id}
GET, POST, PUT endpointsInvoice.line_items[].tax_rate_id
on /v1/invoices
GET endpointInvoice.line_items[].tax_rate_id
on /v1/invoices/{id}
GET endpointCustomer.custom_payment_delay
on /v1/customers
GET endpointCustomer.custom_payment_delay
on /v1/customers/{id}
GET, POST, PUT endpointsSubscription.custom_properties
on /v2/subscriptions
GET, POST endpointsSubscription.custom_properties
on /v2/subscriptions/{id}
GET, PUT endpoints/v1/quotes/{id}/sign
POST endpoint/v1/invoices/{id}/void
POST endpointCustomer.timezone
on /v1/customers
GET, POST endpointsCustomer.timezone
on /v1/customers/{id}
GET, PUT endpointsSubscription.payment_method_strategy
is now optional on /v2/subscriptions
POST endpoint/v1/organisations/{id}
GET endpoint/v1/organisations/{id}
PATCH endpointCustomer.organisation_id
and Customer.organisation_invoicing
on /v1/customers
POST endpointCustomer.organisation_id
and Customer.organisation_invoicing
on /v1/customers/{id}
GET, PUT endpointsSubscription.contract_start
and Subscription.contract_end
on /v2/subscriptions/*
endpointsSubscription.products[].attached_at
and Subscription.products[].detached_at
on /v2/subscriptions/*
endpoints/v1/subscriptions/{id}/reinstate
POST endpointupdate_prices
SubscriptionUpdate.type
on /v1/subscriptions/{id}/update
POST endpoint/v1/subscriptions/{id}/update-many
POST endpointSubscription.starts_at
in favor of Subscription.contract_start
SubscriptionUpdate.payload.billing_item_ids
in favor of SubscriptionUpdate.payload.product_ids
for add_coupon
update typeadd_item
SubscriptionUpdate.type
in favor of add_product
remove_item
SubscriptionUpdate.type
in favor of remove_product
/v1/quotes
POST endpoint/v1/quotes/{id}/download
GET endpoint/v1/quotes/{id}/send
POST endpoint/v1/quotes/{id}/void
POST endpointCustomer.custom_properties
on /v1/customers
GET endpoint/v1/quotes
GET endpoint/v1/quotes/{id}
GET endpoint/v1/quotes/{quoteId}/files/{id}/download
GET endpointGET /v1/subscriptions
in favor of GET /v2/subscriptions
GET /v1/subscriptions/{id}
in favor of GET /v2/subscriptions/{id}
POST /v1/subscriptions
in favor of POST /v2/subscriptions
GET /v1/billing-plans/{id}
in favor of GET /v1/plans/{id}
GET /v1/billing-scenarios
GET /v1/billing-scenarios/{id}
/v1/subscriptions/{id}/pause
PUT endpoint/v1/subscriptions/{id}/reactivate
PUT endpoint/v1/subscriptions/refresh
POST endpoint/v1/webhooks/endpoints
GET, POST endpoints/v1/webhooks/endpoints/{id}
GET, PUT, DELETE endpointsWalletBalance.units
WalletSettings.unit_credit_prices
WalletTransaction.units
and WalletTransaction.transaction_id
Customer.current_subscription_id
on /v1/customers
GET endpointCustomer.current_subscription
on /v1/customers/{id}
GET endpointCustomer.type
on /v1/customers
GET, POST and PUT endpointsCustomer.invoice_emails
on /v1/customers
GET, POST and PUT endpointsCustomer.vat_rate_custom
on /v1/customers
GET, POST and PUT endpointsexternal
option on Customer.payment_method_type
on /v1/customers
POST and PUT endpointsCustomer.country
in favor of Customer.billing_address.country
GET /v1/subscriptions
in favor of GET /v2/subscriptions
GET /v1/subscriptions/{id}
in favor of GET /v2/subscriptions/{id}
POST /v1/subscriptions
in favor of POST /v2/subscriptions
Customer.current_subscription_id
on /v1/customers
GET endpoint in favor of Customer.subscriptions
Customer.current_subscription
on /v1/customers/{id}
GET endpoint in favor of Customer.subscriptions