{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands BillingPlans API", "version": "v2.1" }, "items": [ { "info": { "name": "BillingPlans", "type": "folder" }, "items": [ { "info": { "name": "Docusign Get Account Billing Plan", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/billing_plan", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "include_credit_card_information", "value": "", "type": "query", "description": "When set to **true**, payment information including credit card information will show in the return." }, { "name": "include_metadata", "value": "", "type": "query", "description": "When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information. " }, { "name": "include_successor_plans", "value": "", "type": "query", "description": "When set to **true**, excludes successor information from the response." } ] }, "docs": "Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\n\nBy default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the `setting` set to **false**. \n\nResponse\n\nThe response returns the billing plan information, including the currency code, for the plan. The `bill" }, { "info": { "name": "Docusign Updates the account billing plan.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/billing_plan", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "preview_billing_plan", "value": "", "type": "query", "description": "When set to **true**, updates the account using a preview billing plan." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the billing plan information, billing address, and credit card information for the specified account." }, { "info": { "name": "Docusign Get metadata for a given credit card.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/billing_plan/credit_card", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ] }, "docs": "Docusign Get metadata for a given credit card." }, { "info": { "name": "Docusign Reserverd: Purchase additional envelopes.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/billing_plan/purchased_envelopes", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor." }, { "info": { "name": "Docusign Gets the list of available billing plans.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/billing_plans" }, "docs": "Retrieves a list of the billing plans associated with a distributor." }, { "info": { "name": "Docusign Get the billing plan details.", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/billing_plans/:billingPlanId", "params": [ { "name": "billingPlanId", "value": "", "type": "path", "description": "The ID of the billing plan being accessed." } ] }, "docs": "Retrieves the billing plan details for the specified billing plan ID." } ] } ], "bundled": true }