You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Update the organization profile

Resource Summary

Security

Content Type

application/json

Category

Organization profile,

Update the organization profile

PUT

Update the organization profile

Update the organization profile. See also Editing the organization profile using the API.

Note: When you update the organization profile, you need to specify all the organization profile settings, not only the settings you want to update. You might want to view the organization profile copy the response payload, modify it as required, and then pass the modified payload in the request body.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "address": { "type": "array", "description": "Address of the organization. Note: The address is displayed at the API package-level only.", "items": { "properties": { "address1": { "type": "string", "description": "Street address of the bank at which the account is held." }, "city": { "type": "string", "description": "City." }, "country": { "type": "string", "description": "Country." }, "id": { "type": "string", "description": "ID of the address. This value must be unique when creating an entity." }, "isPrimary": { "type": "boolean", "description": "Flag that specifies whether this is the primary address." }, "state": { "type": "string", "description": "State." }, "zip": { "type": "string", "description": "Zip code." } } } }, "approvedTrusted": { "type": "boolean", "description": "Flag that specifies whether the developer is given approved status by the organization." }, "approvedUntrusted": { "type": "boolean", "description": "Flag that specifies whether untrusted developers are given approved status by the organization." }, "billingCycle": { "type": "string", "description": "Billing cycle period. Valid values include:
  • PRORATED: Billing is based on the number of days that an API product is used in a calendar month.
  • CALENDAR_MONTH: Billing is done monthly.
" }, "country": { "type": "string", "description": "ISO 3166-2 code for the country of operation for the organization, such as US for United States or BR for Brazil." }, "currency": { "type": "string", "description": "ISO 4217 code for the "base" or accounting currency that the organization uses, such as usd for Unites States dollar. For revenue sharing plans, the specified currency is used for your plan. For rate card (charging model) plans, the specified currency is used as the default currency; however, you can change the currency setting to any currency supported by the organization. For fees only plans, you can change the currency setting to any currency supported by the organization." }, "description": { "type": "string", "description": "Brief description of the organization." }, "hasBillingAdjustment": { "type": "boolean", "description": "Flag that specifies whether adjustments are enabled. If enabled, you can make adjustments to the traffic details recorded by API services for your API products." }, "hasBroker": { "type": "boolean", "description": "Flag that specifies whether the revenue is based on net." }, "hasSelfBilling": { "type": "boolean", "description": "Flag that directs monetization to generate a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer." }, "hasSeparateInvoiceForProduct": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is generated for each API product." }, "id": { "type": "string", "description": "ID of the organization." }, "issueNettingStmt": { "type": "boolean", "description": "Flag that specifies whether a netting statement is generated when creating billing documents." }, "logoUrl": { "type": "string", "description": "URL of the organization's logo." }, "name": { "type": "string", "description": "Name of the organization." }, "netPaymentAdviceNote": { "type": "string", "description": "Net payment advice note." }, "nettingStmtPerCurrency": { "type": "boolean", "description": "Flag that specifies whether a separate netting statement is generated for each currency used." }, "regNo": { "type": "string", "description": "Organization's registration number. The registratino number is displayed at the bottom of billing documents." }, "selfBillingAsExchOrg": { "type": "boolean", "description": "This feature is deprecated." }, "selfBillingForAllDev": { "type": "boolean", "description": "If self-billing invoices are enabled, flag that specifies whether they are enabled for all developers. By default, self-billing invoices are generated only for developers who have signed an agreement with the API provider." }, "separateInvoiceForFees": { "type": "boolean", "description": "Flag that specifies whether a separate invoice is published for fees." }, "status": { "type": "string", "description": "Status of the organization. Valid values include:
  • ACTIVE: The organization account is registered in monetization and is available for use.
  • INACTIVE: The organization account is registered in monetization, but is not available for use.
" }, "supportedBillingType": { "type": "string", "description": "Developer payment model used for billing. Valid values include:
  • PREPAID: The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID: The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH: In this case, the billing type defaults to PREPAID.
" }, "taxEngineExternalId": { "type": "string", "description": "External ID for a third-party tax engine." }, "taxModel": { "type": "string", "description": "Note: This property only applies if you set up revenue sharing plans and you want monetization to generate billing documents. Tax model you want to use for revenue sharing plans which dictates the type of billing documents that monetization produces. This applies to an individual operator or organization. Valid values include:
  • Disclosed: In this tax model, the API provider acts as a disclosed agent of the developer. The gross revenue (including sales taxes) collected from the end user is passed to the developer. The API provider’s commission is collected from the developer in the form of a commission invoice. The API provider does not handle the sales tax collected from the end user, and it is the developer’s responsibility to report the sales tax.
  • Undisclosed: In this tax model, the API provider acts as an undisclosed agent of the developer, and deducts the tax collected from the end users and pays it to the local tax authorities. The developer invoices the API provider for the net revenue share due to the developer (less sales taxes and the API provider’s commission).
  • Hybrid: In this tax model, the API provider acts as a disclosed agent of the developer. However, the API provider pays the sales tax collected from their subscribers to the local tax authorities on the developer’s behalf. The API provider passes the remaining revenue to the developer, and then invoices for commission charges.
" }, "taxNexus": { "type": "string", "description": "The country in which the organization is registered for tax purposes. Note: If the tax nexus is the United States, you need to provide additional information on all the states where you are registered for tax purposes. You provide this information as part of a configuration questionnaire when you first purchase monetization." }, "taxRegNo": { "type": "string", "description": "Organization’s tax registration number or Value Added Tax (VAT) registration number, if applicable. This property is optional because the tax registration number or VAT registration number does not apply in all countries. The VAT registration number is displayed at the bottom of billing documents." }, "transactionalRelayURL": { "type": "string", "description": "URL of another system to which transactions can be relayed, such as a data warehouse." }, "timezone": { "type": "string", "description": "The time zone identifier for the organization’s operations, such as America/New_York or Europe/Paris. Time zone abbreviations, such as EST (Eastern Standard Time) or CET (Central European Time), are also supported. Use caution when updating the timezone setting in an organization profile, as it can impact date- and time-based events including when a rate plan starts and ends and when notifications are sent." } }

org_name Name of your organization. true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)