API Changes Allowed or Restricted in Different APIs
Customer API
| customer_create | Allowed |
|---|---|
| customer_update | Not Allowed |
| customer_update_payment_method | Not Allowed |
| customer_update_billing | Not Allowed |
| assign_payment_role | Allowed |
| add_contact | Not Allowed |
| update_contact | Not Allowed |
| delete_contact | Not Allowed |
| add_promotional_credits | Not Allowed |
| deduct_promotional_credits | Not Allowed |
| set_promotional_credits | Not Allowed |
| record_excess_payment | Not Allowed |
| customer_collect_payment | Not Allowed |
| delete | Not Allowed |
| move | Allowed |
| change_billing_date | Not Allowed |
| merge_customers | Allowed (partially) |
| customer_clear_personal_data | Allowed |
| link_a_customer | Not Allowed |
| delete_relationship | Not Allowed |
| update_hierarchy_settings | Not Allowed |
Subscription API
| sub_create_item | Not Allowed |
|---|---|
| remove_scheduled_changes | Not Allowed |
| remove_scheduled_cancellation_ep | Not Allowed |
| remove_coupons | Not Allowed |
| sub_update_for_items | Not Allowed |
| change_term_end | Not Allowed |
| reactivate_subscription | Not Allowed |
| add_charge_at_term_end | Not Allowed |
| charge_future_renewals | Not Allowed |
| edit_advance_invoice_schedule | Not Allowed |
| remove_advance_invoice_schedule | Not Allowed |
| regenerate_invoice | Not Allowed |
| import_contract_term | Not Allowed |
| import_unbilled_charges | Not Allowed |
| delete_subscription | Not Allowed |
| pause | Not Allowed |
| cancel_for_items | Not Allowed |
| resume_subscription (Intermediate) | Allowed |
| resume_subscription (Transferred) | Not Allowed |
| remove_scheduled_pause | Not Allowed |
| remove_scheduled_resumption | Not Allowed |
Invoice API
| update_invoice | Not Allowed |
|---|---|
| record_payment | Allowed |
| record_refund | Not Allowed |
| create_for_charge_items_and_charges | Not Allowed |
| stop_dunning | Not Allowed |
| import_invoice | Not Allowed |
| invoice_apply_payments | Allowed |
| sync_usages | Not Allowed |
| delete_line_items | Not Allowed |
| invoice_apply_credits | Not Allowed |
| add_charge_pending | Not Allowed |
| add_charge_item | Not Allowed |
| close_now | Allowed |
| collect_payment | Allowed |
| record_tax_withheld | Not Allowed |
| remove_tax_withheld | Not Allowed |
| refund_invoice | Not Allowed |
| remove_payment | Not Allowed |
| remove_credit_note | Not Allowed |
| void_invoice | Not Allowed |
| write_off | Not Allowed |
| delete_invoice | Not Allowed |
| resend_einvoice | Not Allowed |
| send_einvoice | Not Allowed |
Credit Note API
| create_credit_note | Not Allowed |
|---|---|
| refund | Allowed |
| import_credit_note | Not Allowed |
| record_refund | Allowed |
| void | Not Allowed |
| delete | Not Allowed |
| remove_tax_withheld_refund | Not Allowed |
| resend_einvoice | Not Allowed |
| send_einvoice | Not Allowed |
Quote API
| update_sub_items_quote | Not Allowed |
|---|---|
| one_time_charge_items_quote | Not Allowed |
| create_sub_items_quote | Not Allowed |
Promotional Credit API
| add | Not Allowed |
|---|---|
| deduct | Not Allowed |
| set | Not Allowed |
Address API
| address_update | Not Allowed |
|---|
Usage API
| create_usage (Intermediate) | Allowed |
|---|---|
| delete_usage (Intermediate) | Allowed |
| create_usage (Transferred) | Not Allowed |
| delete_usage (Transferred) | Not Allowed |
Unbilled Charge API
| unbilled_charges_create_for_items | Not Allowed |
|---|---|
| invoice_unbilled_charges | Not Allowed |
| delete | Not Allowed |
| invoice_now_estimate | Not Allowed |
Estimate API
| estimate_createsub_for_item_with_customer | Allowed |
|---|---|
| estimate_createsub_for_customer | Not Allowed |
| estimate_createsub_for_item | Allowed |
| estimate_updatesub_for_items | Not Allowed |
| advance_invoice_estimate | Not Allowed |
| regenerate_invoice_estimate | Not Allowed |
| upcoming_invoice_for_cmrr | Not Allowed |
| change_term_end_estimate | Not Allowed |
| cancel_subscription_for_items_estimate | Not Allowed |
| pause_subscription_estimate | Not Allowed |
| resume_subscription_estimate | Allowed |
| gift_subscription_for_items | Not Allowed |
| create_invoice_for_items | Not Allowed |
Transaction API
| create_an_authorization_payment | Allowed |
|---|---|
| cancel_an_authorization_payment | Allowed |
| sync_transaction (Bulk Operation) | Allowed |
| record_refund | Not Allowed |
| refund_transaction | Not Allowed |
| delete_offline_transaction | Not Allowed |
Hosted Page API
| checkout_one_time | Not Allowed |
|---|---|
| checkout_one_time_for_items | Not Allowed |
| checkout_new_for_items | Not Allowed |
| checkout_existing_for_items | Not Allowed |
| manage_payments | Allowed |
| update_payment_method_hp | Allowed |
| collect_unpaid_invoices | Allowed |
| accept_quote | Not Allowed |
| extend_subscription | Not Allowed |
| checkout_gift_for_items | Not Allowed |
| claim_gift | Allowed |
| acknowledge_hosted_page | Allowed |
| precancel | Not Allowed |
| events | Allowed |
| view_voucher | Allowed |
Gift API
| gift_create_for_items | Not Allowed |
|---|---|
| claim_gift | Allowed |
Order API
| Operation | Permission |
|---|---|
| createOrderConfig | Not Allowed |
| updateOrderConfig | Not Allowed |
| importOrder | Not Allowed |
| assignOrderNumberConfig | Not Allowed |
| cancelOrderConfig | Not Allowed |
| refundOrderConfig | Not Allowed |
| reopenOrderConfig | Not Allowed |
| deleteOrder | Not Allowed |
| resendOrderConfig | Not Allowed |
Portal API
| Operation | Permission |
|---|---|
| portal_session_create | Allowed |
| logout | Allowed |
| activate | Allowed |
Payment Source API
| switch_gateway_account | Not Allowed |
|---|
Credit Card API
| switchGatewayForCustomer | Not Allowed |
|---|---|
| copyCardForCustomer | Not Allowed |
| deleteCardForCustomer | Allowed |
Go Back To
Was this article helpful?