Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

    API Changes Allowed or Restricted in Different APIs

    Customer API

    customer_createAllowed
    customer_updateNot Allowed
    customer_update_payment_methodNot Allowed
    customer_update_billingNot Allowed
    assign_payment_roleAllowed
    add_contactNot Allowed
    update_contactNot Allowed
    delete_contactNot Allowed
    add_promotional_creditsNot Allowed
    deduct_promotional_creditsNot Allowed
    set_promotional_creditsNot Allowed
    record_excess_paymentNot Allowed
    customer_collect_paymentNot Allowed
    deleteNot Allowed
    moveAllowed
    change_billing_dateNot Allowed
    merge_customersAllowed (partially)
    customer_clear_personal_dataAllowed
    link_a_customerNot Allowed
    delete_relationshipNot Allowed
    update_hierarchy_settingsNot Allowed

    Subscription API

    sub_create_itemNot Allowed
    remove_scheduled_changesNot Allowed
    remove_scheduled_cancellation_epNot Allowed
    remove_couponsNot Allowed
    sub_update_for_itemsNot Allowed
    change_term_endNot Allowed
    reactivate_subscriptionNot Allowed
    add_charge_at_term_endNot Allowed
    charge_future_renewalsNot Allowed
    edit_advance_invoice_scheduleNot Allowed
    remove_advance_invoice_scheduleNot Allowed
    regenerate_invoiceNot Allowed
    import_contract_termNot Allowed
    import_unbilled_chargesNot Allowed
    delete_subscriptionNot Allowed
    pauseNot Allowed
    cancel_for_itemsNot Allowed
    resume_subscription (Intermediate)Allowed
    resume_subscription (Transferred)Not Allowed
    remove_scheduled_pauseNot Allowed
    remove_scheduled_resumptionNot Allowed

    Invoice API

    update_invoiceNot Allowed
    record_paymentAllowed
    record_refundNot Allowed
    create_for_charge_items_and_chargesNot Allowed
    stop_dunningNot Allowed
    import_invoiceNot Allowed
    invoice_apply_paymentsAllowed
    sync_usagesNot Allowed
    delete_line_itemsNot Allowed
    invoice_apply_creditsNot Allowed
    add_charge_pendingNot Allowed
    add_charge_itemNot Allowed
    close_nowAllowed
    collect_paymentAllowed
    record_tax_withheldNot Allowed
    remove_tax_withheldNot Allowed
    refund_invoiceNot Allowed
    remove_paymentNot Allowed
    remove_credit_noteNot Allowed
    void_invoiceNot Allowed
    write_offNot Allowed
    delete_invoiceNot Allowed
    resend_einvoiceNot Allowed
    send_einvoiceNot Allowed

    Credit Note API

    create_credit_noteNot Allowed
    refundAllowed
    import_credit_noteNot Allowed
    record_refundAllowed
    voidNot Allowed
    deleteNot Allowed
    remove_tax_withheld_refundNot Allowed
    resend_einvoiceNot Allowed
    send_einvoiceNot Allowed

    Quote API

    update_sub_items_quoteNot Allowed
    one_time_charge_items_quoteNot Allowed
    create_sub_items_quoteNot Allowed

    Promotional Credit API

    addNot Allowed
    deductNot Allowed
    setNot Allowed

    Address API

    address_updateNot 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_itemsNot Allowed
    invoice_unbilled_chargesNot Allowed
    deleteNot Allowed
    invoice_now_estimateNot Allowed

    Estimate API

    estimate_createsub_for_item_with_customerAllowed
    estimate_createsub_for_customerNot Allowed
    estimate_createsub_for_itemAllowed
    estimate_updatesub_for_itemsNot Allowed
    advance_invoice_estimateNot Allowed
    regenerate_invoice_estimateNot Allowed
    upcoming_invoice_for_cmrrNot Allowed
    change_term_end_estimateNot Allowed
    cancel_subscription_for_items_estimateNot Allowed
    pause_subscription_estimateNot Allowed
    resume_subscription_estimateAllowed
    gift_subscription_for_itemsNot Allowed
    create_invoice_for_itemsNot Allowed

    Transaction API

    create_an_authorization_paymentAllowed
    cancel_an_authorization_paymentAllowed
    sync_transaction (Bulk Operation)Allowed
    record_refundNot Allowed
    refund_transactionNot Allowed
    delete_offline_transactionNot Allowed

    Hosted Page API

    checkout_one_timeNot Allowed
    checkout_one_time_for_itemsNot Allowed
    checkout_new_for_itemsNot Allowed
    checkout_existing_for_itemsNot Allowed
    manage_paymentsAllowed
    update_payment_method_hpAllowed
    collect_unpaid_invoicesAllowed
    accept_quoteNot Allowed
    extend_subscriptionNot Allowed
    checkout_gift_for_itemsNot Allowed
    claim_giftAllowed
    acknowledge_hosted_pageAllowed
    precancelNot Allowed
    eventsAllowed
    view_voucherAllowed

    Gift API

    gift_create_for_itemsNot Allowed
    claim_giftAllowed

    Order API

    OperationPermission
    createOrderConfigNot Allowed
    updateOrderConfigNot Allowed
    importOrderNot Allowed
    assignOrderNumberConfigNot Allowed
    cancelOrderConfigNot Allowed
    refundOrderConfigNot Allowed
    reopenOrderConfigNot Allowed
    deleteOrderNot Allowed
    resendOrderConfigNot Allowed

    Portal API

    OperationPermission
    portal_session_createAllowed
    logoutAllowed
    activateAllowed

    Payment Source API

    switch_gateway_accountNot Allowed

    Credit Card API

    switchGatewayForCustomerNot Allowed
    copyCardForCustomerNot Allowed
    deleteCardForCustomerAllowed

    Go Back To

    Was this article helpful?