/
GE
getlago
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
activity_logs
2
add_ons
5
analytics
6
api_logs
2
billable_metrics
6
billing_entities
4
coupons
8
credit_notes
11
customers
15
entitlements
10
get
/plans/{code}/entitlements
List all entitlements
post
/plans/{code}/entitlements
Create an entitlement
patch
/plans/{code}/entitlements
Partial update of an entitlement
get
/plans/{code}/entitlements/{feature_code}
Retrieve an entitlement
delete
/plans/{code}/entitlements/{feature_code}
Delete an entitlement
delete
/plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}
Remove a privilege from an entitlement
get
/subscriptions/{external_id}/entitlements
List all subscription entitlements
patch
/subscriptions/{external_id}/entitlements
Update subscription entitlements
delete
/subscriptions/{external_id}/entitlements/{feature_code}
Remove an entitlement from a subscription
delete
/subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}
Remove a privilege from a subscription entitlement override
events
7
features
6
fees
4
invoices
14
order_forms
4
orders
3
organizations
2
payment_methods
3
payment_receipts
2
payment_requests
3
payments
3
plans
24
quotes
7
subscriptions
24
taxes
5
wallets
30
webhook_endpoints
5
webhooks
2
Webhooks
post
add_on_created
A new add-on has been created
post
add_on_updated
An add-on has been updated
post
add_on_deleted
An add-on has been deleted
post
alert_resolved
An alert was resolved
post
alert_triggered
A new alert was triggered
post
billable_metric_created
A new billable metric has been created
post
billable_metric_updated
A billable metric has been updated
post
billable_metric_deleted
A billable metric has been deleted
post
customer_created
A new customer has been created
post
customer_updated
A customer has been updated
post
customer_accounting_provider_created
A customer was created on an accounting integration
post
customer_accounting_provider_error
An error was encountered while syncing a customer to an accounting provider
post
customer_crm_provider_created
A customer has been created in the CRM provider
post
customer_crm_provider_error
An error was encountered while syncing a customer to a CRM provider
post
customer_payment_provider_created
A customer has been created on a payment provider
post
customer_payment_provider_error
An error was encountered while syncing a customer to a payment provider
post
customer_checkout_url_generated
A checkout URL was generated for a customer
post
customer_tax_provider_error
An error was encountered while fetching taxes for a customer on a tax provider
post
customer_vies_check
VIES VAT number has been checked for a customer
post
credit_note_created
A new credit note has been created
post
credit_note_generated
A new credit note PDF has been generated
post
credit_note_provider_refund_failure
The refund of a credit note has failed on a payment provider
post
coupon_created
A new coupon has been created
post
coupon_updated
A coupon has been updated
post
coupon_deleted
A coupon has been deleted
post
coupon_terminated
A coupon has been terminated
post
dunning_campaign_finished
The dunning campaign has been completed for a customer
post
event_error
An error has been detected on an event
post
events_errors
Errors were encountered while post-processing some events
post
feature_created
A new feature has been created
post
feature_updated
A feature has been updated
post
feature_deleted
A feature has been deleted
post
fee_created
A pay in advance fee has been created
post
fee_tax_provider_error
An error was encountered while fetching taxes for a fee on a tax provider
post
invoice_created
A new invoice has been emitted
post
invoice_one_off_created
A new one off invoice has been emitted
post
invoice_add_on_added
A new add on invoice has been emitted
post
invoice_paid_credit_added
A new prepaid credit invoice has been emitted
post
invoice_generated
A new invoice PDF has been generated
post
invoice_drafted
A new draft invoice has been emitted
post
invoice_ready_to_finalize
A draft invoice is ready to be finalized
post
invoice_voided
An invoice has been voided
post
invoice_deleted
A draft invoice has been deleted
post
invoice_payment_dispute_lost
A payment dispute has been lost for an invoice payment
post
invoice_payment_status_updated
The payment status of an invoice has been updated
post
invoice_payment_overdue
An invoice payment is overdue
post
invoice_payment_failure
A payment attempt for an invoice has failed on a payment provider
post
invoice_resynced
An invoice has been resynced with Salesforce
post
integration_provider_error
An error was encountered while processing data on an integration
post
order_created
An order has been created from a signed order form
post
order_executed
An order has been executed
post
order_form_created
An order form has been generated from an approved quote
post
order_form_signed
An order form has been marked as signed
post
order_form_expired
An order form has expired
post
order_form_voided
An order form has been voided
post
payment_requires_action
An action is required to process a payment
post
payment_succeeded
A payment has been successfully processed
post
payment_provider_error
An error was raised by a payment provider
post
payment_receipt_created
A new payment receipt has been created
post
payment_receipt_generated
The PDF of a payment receipt has been generated
post
payment_request_created
A new payment request has been created
post
payment_request_payment_failure
A payment attempt for a payment request has failed on a payment provider
post
payment_request_payment_status_updated
The payment status of a payment request has been updated
post
plan_created
A new plan has been created
post
plan_updated
A plan has been updated
post
plan_deleted
A plan has been deleted
post
quote_created
A new quote has been created
post
quote_approved
A quote has been approved
post
quote_voided
A quote has been voided
post
subscription_terminated
A subscription has been terminated
post
subscription_incomplete
A subscription is incomplete and waiting for payment
post
subscription_canceled
A subscription has been canceled
post
subscription_started
A subscription has started
post
subscription_updated
A subscription has been updated
post
subscription_termination_alert
A subscription will be terminated in the future
post
subscription_trial_ended
A subscription trial period has ended
post
subscription_usage_threshold_reached
A usage threshold has been reached by a subscription
post
wallet_created
A new wallet has been created
post
wallet_updated
A wallet has been updated
post
wallet_terminated
A wallet has been terminated
post
wallet_depleted_ongoing_balance
The balance of a wallet has been depleted
post
wallet_transaction_created
A new wallet transaction has been created
post
wallet_transaction_updated
A wallet transaction has been updated
post
wallet_transaction_payment_failure
A payment attempt for a wallet transaction has failed on a payment provider
entitlements
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Create an entitlement
post
/plans/{code}/entitlements
Nov 3, 2026
5d26657495a3
Revision changes
info
the request property
entitlements
became optional