Zuora promo code api. ; In the General tab, complete the following settings: .
Zuora promo code api Important: This API Reference only showcases the parameters, fields, and behaviors available for the latest API minor version (2024-05-20). The Promo Code decision would generate decision response like a regular Dynamic Offer, but with the discount output according to the Promo Code's discount rule. Field Types Lists the resource codes for the Zuora REST API. Configure additional Accounting Periods as necessary and try again. Add promo codes; Integration Methods 1,000+ companies trust Zuora’s industry-leading technology and expertise to unlock the full The following table lists the resources codes ranging from 510000 to 519999. RatePlanCharge. Configure JavaScript run method; Configure the CDN API endpoint; Install a standalone website; Example Implementation; Use Zephr functionality through third-Party CDNs; Cross-domain Cookies in JavaScript Discount Property. Zuora only retries a callout if the response code is one of the following: 1xx; 403; 408; 429; 5xx; Negative; Note that if the custom request body of callout notifications is invalid, a -2000 response code is returned, and Zuora will neither send the callout notification Describes code Samples on Github and . Campaign level. Invoice. Discount Property. Customer Catalog - The portal synchronizes with the Zuora Product Catalog and creates a local version called Customer Catalog. namespace: 710002: definition. Field Types Discount-Fixed Amount is a fixed amount discount charge model, such as a one-time, $100 discount if the customer signs up for a subscription in January. The objective of these 2 headers is to limit the data visibility for query APIs. View the promo code details, such as the title, code (multi-use), code prefix (unique promo codes), usage count, remaining uses, and the current status of the promo code. Live Promo Codes: Only future start and end dates can be edited. . Example 1; Example 2; Use the Submit an aggregate query job API operation with the apiVersion query parameter to submit an aggregate query with a specified API version. From Zuora Release 2022. Create an Invoice API Generator Task; Template Fields; Known Limitation; Zuora's Invoice API Generator enables you to generate invoices of historical versions in bulk. Run a Report requires the ReportId value as a request path value. Within NetSuite, go to Setup > Accounting > Manage Accounting Periods. You can test the Zuora REST API from the Zuora Sandbox or Production tenants. Code Examples. optional: Create Query Update Delete Filter: Unique account number assigned to the account. The following table lists the resources codes ranging from 510000 to 519999. Quickstart API changelog. select id, createdDate,createdById,updatedDate,updatedById Resource codes for Billing and Payments REST API No image available Introduces the resource codes for the Zuora Billing REST API. Field Types The Run a Report Reporting API starts a new report run and returns the ReportRunId. Browser-side HTML Features. To use the version-controlled parameters or get version-controlled fields, you can specify the zuora-version request header to the version you want to use. Zuora's product catalog provides two discount charge models, Discount-Fixed Amount and Discount-Percentage. Each standard event has a unique event category code and falls under a parent category, represented by a unique parent category code. Alternatively, if configured and the feature is enabled, this api can execute a dynamic offer rule that is linked to this promo code. To create a SOAP request: Navigate to New Task > Generic API Utility. For more information, see Adding Promo Codes. For example, you can use Settings API to get a specific setting, update a specific setting, and initiate any GET, POST, PUT, DELETE operations in a batch through a batch request. Discount Rate Plans to Add: Select Percent Discount Rate Plan; Product - RatePlan: Percent Discount Rate Plan; Discount Percentage: 25 Getting Started with the SOAP API. Field Types As the association between some Settings API field names and their corresponding texts on the Zuora UI is not very obvious, you may refer to these comparison tables for help when you configure subscription and order settings, billing rules, payment rules, and accounting rules through the Settings API. required: 710005 Extensibility Powered by Zuora: Utilize Zuora Workflow for no-code or low-code customization of subscriber engagement based on app store activity. Field Types Resource code Resource; 710000: definition: 710001: definition. See Assign Accounting Codes for more information on how to manage accounting codes using the Zuora user interface. Select the timing of execution from the Execution drop-down list. Navigate to Background Workers > Actions > Import - Update Single Use Codes. DiscountApplyDetailData added; No: Query apply details info from the discount rate plan charge. Once on the configuration page, enter the URL template for your API. The portal calls out to external APIs and retrieves data. This option is available only if you have the Zuora Warehouse feature enabled in your tenant. Version notes: WSDL 47. Character limit: 32. Getting Started with the SOAP API; Coding Overview; Use Cases and Code Samples; SOAP API Object Relationships; SOAP The resource code indicates the Billing REST API resource, typically a field of a Zuora object, on which the issue occurs. A code identifying the reason for the transaction. Name Required to Create? Allowed Operations Description; AccountNumber. Field Types API Examples; Promo Codes. Getting Started with the SOAP API; Coding Overview; Use Cases and Code Samples; SOAP API Object Relationships; SOAP You can use the Zephr API to do the following: Apply the promo code to your payment form 翻訳に関するフィードバックについては、docs@zuora. Type Zuora-Org-Ids. Dates in the past The Decision Data API screen in Zephr allows you to integrate external data for real-time decision-making. The following fields are required to create a product: Name; Effective start date; Effective end date The Zuora v1 API uses API versions to control backward-incompatible changes, such as deprecating a field on an object or replacing a parameter in a request. No headers. In the General tab, complete the following configuration: Enter the name of the task in the Name field. See Configure custom fields to learn more about the custom field hierarchy of the Promo Codes app. The returned dataset is specific to the orgs specified using the above headers. Version notes: --Values: populated by Zuora Quotes. Add a new discount output; Dynamic offers versioning; Preview and validate dynamic offers; Report on Dynamic Offers conversion data; Sync data modal and custom field cache for Dynamic Offers; API Examples; Promo Codes. Follow the Developer Blog to learn about new developer experience product features For example, if you set AQuA API Stateful Mode Time Offset to 600 seconds and you submit a query in stateful mode at 2:00 AM, Zuora returns data that were created or updated between the completion time of the previous stateful query and 1:50 AM. Parent category code: This code represents a product area or object in Zuora. Field Types Create a Product. ; Review the Revenue Recognition Template configuration within NetSuite (Lists > Accounting > Revenue Recognition Templates), verify the Revenue Recognition Start and End Dates encompass any Start or Period Offsets, adjust the Revenue Recognition Getting Started with the SOAP API. Field Types Use a Promo Code on a Payment Form Last updated; < Back to home Collapse All. After the campaign is created, you can create child campaigns that hold different types of promotion codes. For more information about Zuora API versions, see API versions and API upgrades. Integrate in existing technology stack Zuora categorizes standard events based on their associated objects. *}} {{site}} Zuora uses the HTTP response code to determine whether to retry callouts. GET /api /v1 /tools /promos /{code} /validate?customFields%5B{example_key}%5D={example_value} May 20, 2024 · Welcome to the v1 API reference for the Zuora Billing, Payments, and Central Platform! To learn about the common use cases of the Zuora v1 API, check out the API Tutorials. BillToContactSnapshotId added Zuora's Developer Tools is a set of applications that ease the effort to onboard new customers, and perform mass migration and updates. The following table lists the resources codes ranging from 600000 to 619999. You can use the discount charge models to offer your customers a variety of discount options, such as: Task 1: Create and apply enhanced discounts through Zuora UI. Take the following steps to create a task using the Generic API Loader: Navigate to New Task > Generic API Loader. Specify your own validation rules for each code generated in the system. Promo Codes - The coupons and offers that leverage Zuora discount plans. zip files with sample code for PHP, Java, . Type: string Character limit: 3 Version notes: Values: a valid currency code. Establishing such a user account requires either being an administrator in the Zuora tenant or having access to your coworkers who are administrators in the tenant. See Set up Chart of Accounts for additional information. Zuora WSDL; Date Field Changes in the WSDL; Custom Fields in SOAP Objects; SOAP API FAQs; Coding Overview. You can use the Subscription API Loader to load the desired subscriptions, then use Invoice API Generator to generate invoices and update the invoices to "Posted". Upload the configured CSV file. Select a run mode from the Run Mode drop-down list. Select the configured CSV You can use Promo Codes to link Stripe Coupons to Zephr Products. Field Types The following table lists the resources codes ranging from 520000 to 529999. For example, 531003 refers to the termType field of the subscription object. APIs to create, validate, and consume campaigns and promotion codes. Field Types How Accounting Codes are Used in Zuora. Live - Run data queries against Zuora transactional database, which are updated in near real-time. REST API Resource Codes No image available Lists the resource codes for the Zuora REST API. These 2 headers are supported for all the Zuora public APIs and are applicable only when Multi-Org is enabled. Responds with a list of redemption results for each promo code. Editing Validity Dates: Draft Promo Codes: All fields, including validity dates, remain fully editable until the promo code is set to LIVE. Highly Scalable & Real-Time Processing: Support high-scale consumer subscription businesses with the capability to process millions of subscription change events per hour. NET, and XML. Add a new promo code. ProductRatePlanCharge. ; In the General tab, complete the following settings: . Zuora’s Promotion Code Management app offers an efficient and automated solution for this requirement. API Sandbox Zuora Developer Sandbox Zuora Central Sandbox** Streaming API: 1MB payload size; 1K rows/ each API call; 600 API calls/ min ; Format: MultiJson, Single JSON A popular way to do this is to assign a CODE to the rate plan description, which allows you to match a discount code provided by a user via web session to that unique discount rate plan in your product catalog. Similar to the subscribe() call, the amend() call allows you to generate an invoice and capture payment electronically when amending subscriptions. Specify either the invoice number or the invoice ID that contains the line item that you want to adjust. Custom fields in the Promo Codes app can be configured and stored at the following levels: App instance level, where the custom fields are also called global custom fields. 09. The customer API response to the Zuora callout must be HTTP status code 200, or the system considers the callout as a failure. Changes on the following settings can be audited: Billing Default Subscription and Order Settings; Define Billing Rules; Manage Tax codes; Define Discount Settings; Manage Revenue Recognition Codes The following table lists the resources codes ranging from 580000 to 589999. In the New Single Use Codes - Update Job dialog, click Upload File. You can configure a content API connection within your Zephr Admin Console by navigating to Settings > Content API. It gives you the power of a developer through easily manipulated CSV files and a framework that has been tested and maintained by the entire Zuora eco-system. Basic B2C Flow API Tutorial Code Type: Many Single-use code; Prefix: NU-# Autogenerated Characters: 7 # Codes to generate: 100; Eligible Rate Plans: Click Select RatePlans to apply, and add the rate plan for 12 and 24 months, respectively. May 22, 2023 · API Examples; Promo Codes. Create an InvoiceItemAdjustment. ChargeModel is Discount-Fixed Amount. R1, the Quickstart API is available to customers with the Orders (or Order Harmonization) and Invoice Settlement features enabled. The discount can have a separate accounting code and be displayed on the invoice as a particular line item. The Quickstart API allows new integrators to swiftly integrate with Zuora, and it supports essential business use cases. You must specify a URL using the HTTP Secure (https://) protocol. Zuora Audit Trail supports the following capabilities: Track, log, and report on a user’s login history; Track, log, and report on setting changes. This field is required if the value for ProductRatePlanCharge. object: 710003: definition. Discount-Percentage is a percentage discount charge model, such as a 15% discount on all subscription charges for the initial six months of service. Discount-Fixed Amount is a fixed amount discount charge model, such as a one-time, $100 discount if the customer signs up for a subscription in January. Field Types Getting Started with the SOAP API. Zuora Object Zuora Field Salesforce Object Salesforce Field Comments; SubscriptionRatePlan: Zuora__SubscriptionRatePlanHistory__c : External Id : Zuora__External_Id__c Describes the Invoice object, fields, and supported calls. Request URL: Yes: Specify the path to the receiver service of the callout. Settings API allows you to automate your tenant settings management process. Describes Zuora SOAP API standards designed for any developer working with a subscription service who needs a broad range of Zuora functionality and control Describes managing tax codes within the Zuora Tax Engine, including operations to create, retrieve, update, and delete tax codes. Integrate in existing technology stack. Zuora SOAP API complex types are used to group attributes, and provide a convenient method of setting the values of those attributes. This capability allows users to dynamically feed any JSON data into the system, facilitating the evaluation of Zephr rules to determine different paths based on the input. If you specify a value for the productRatePlanChargeId field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT use discount specific accounting codes, rule and segment to manage revenue, regardless of the values specified in the request body: API field name UI text; termType: Default Term Type: initialTerm: Default Initial Term (months) renewalTerm: Default Renewal Term (months) contractRenewal Use a third party client, such as curl, Postman, or Advanced REST Client, to test the Zuora REST API. type: 710004: definition. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Add promo codes; Integration Methods 1,000+ companies trust Zuora’s industry-leading technology and expertise to unlock the full Developer Blog. ReferenceId: Not Required: Create Query Filter: The ID of the payment that the credit balance Dec 2, 2015 · Specify or query the discount class of discount charge. ; Specify the type of adjustment (credit or debit). Zuora-Working-Org. You can specify a parent category as the related event in an Code Examples. Link codes to specific discounts in the Zuora catalog. Resource codes for Billing and Payments REST API; SOAP API No image available Provides an overview of articles related to Zuora SOAP API. Explains how to use the ProductRatePlanCharge object to create or update different discount product rate plan charges. Zuora uses port 443 to send callout notifications by default. Adjust an Invoice Item. May 26, 2023 · API Examples; Promo Codes. The following is an example query on the ProductDiscountApplyDetail object. Add promo codes; Integration Methods. Getting Started with the SOAP API. Field Types Adding a Product to a Subscription (API version 29. Configuring your Content API. Before you can configure Promo Codes in Zephr, you must do the following in Stripe: Create discount options; Link the discount options to the relevant Product Plan. com As a result, the Require Pricing Effective Date setting is locked and cannot be modified once the promo code is LIVE. Type: string. Quickstart Tutorial. Before you start; Set Up Your Site Zuora recommends using OAuth 2. ProductDiscountApplyDetailData added; No: Specify or query the discount charge apply details info. With its ease of configuration and breadth of APIs, the application can manage millions of codes and customers without any manual intervention or custom work-arounds. For alternative API operations, see API Docs for more information. By following this tutorial, you will learn how to build integrations leveraging the Zuora REST API for various use cases. DiscountAmount: optional: Create Query Update Filter: The specific amount for a fixed discount. This article introduces the common operations that you are likely to use in the UI after child campaigns are set up. Discount-Fixed Amount; Discount-Percentage; Task 2: Apply enhanced discounts and specify discount durations through API The following table lists the resources codes ranging from 580000 to 589999. Must be an existing reason code or empty. Create a Generic API Loader Task. Perform the following by clicking the ellipsis icon (…) situated at the end of the table: False - The specified key-value pair does not need to be validated for a promo code discount to be applied. select id, createdDate,createdById,updatedDate,updatedById This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. 0 for all API interactions and using a dedicated user account with the API write access for all API or client libraries interactions. Redeem promo codes that are configured from the Zephr console. The code corresponding to the currency for the tier's price. If connecting to Production, bear in mind that you are working with your live production data, not sample data or test data. Integrate in existing technology stack REST API Resource Codes No image available Lists the resource codes for the Zuora REST API. Working With SOAP; Implementation Considerations; Sessions; SOAP API Sample Source Code; SOAP API Standards; Use Cases and Code Samples; SOAP API Object Relationships; SOAP API Object Reference. It will be used during shopping in the portal. This object provides information about invoices related to a customer account, including dates, the status, and amounts Getting Started with the SOAP API. 0+ Values: a valid reason code. Create SOAP Requests. May 20, 2024 · To learn about the common use cases of the Zuora v1 API, check out the API Tutorials. Zephr has the following URL templates available: {{path}} {{metadata. Alternatively, if you want to create a campaign via API, you can use the "Create a Campaign" operation listed in Swagger API Docs. Warehouse - run the query against Zuora Warehouse, which has better performance and fewer limitations than the Zuora transactional database. 0 and greater, you can use the amend() call to create amendments. QuoteType__QT: optional: Create Query Update Delete Filter Getting Started with the SOAP API. This SOAP API reference describes the fields associated with this base object. Introduces the basic operations on promotion codes, including importing, exporting, copying, moving, updating, and deleting promotion codes, and setting up callouts. The complex types are used by the Zuora API calls and lets you set multiple values or read the results of call actions. If you do not specify a value, Zuora uses the default reason code. 510000 - 519999 Getting Started with the SOAP API. You can obtain the ReportId from the id value in the JSON response to a call of Search by Report Names or you can get it definitively from the response to the Create a Report call. Resolution. Field Types Fields; Example Request; zObject is the base object from which all other SOAP API objects are extended. For integration purposes, specify the apiVersion to ensure consistent and reliable query performance. Enter the homepage of the campaign. When Promo Codes are configured, the promo code field displays on your out-of-the-box payment forms. 0+) In version 29. kbjty jazwn uhbu lfreea bwlrtol kaxpg xgck luld ivce pomqbzwz bbafb eqtez xunfogp agjfoi bpoao