Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"AdPaymentsAccountIdHeader":{"description":"The header used to pass global account associated with the advertiser account. Use `GET` method on the Global Ads Account resource to list the global ads account associated with the access token passed in the HTTP Authorization header and choose `AdvertisingAccountIdentifier` id from the response to pass it as input.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},"AdPaymentsClientHeader":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},"AdPaymentsManagerAccountIdHeader":{"description":"The header used to pass the ID of a manager account. Use `GET` method on the Manager Accounts resource to list the manager accounts associated with the access token passed in the HTTP Authorization header and choose `managerAccountId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}},"AdPaymentsNextTokenQueryParam":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","in":"query","name":"nextToken","schema":{"type":"string"}},"AdPaymentsProfileHeader":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdPaymentsBulkCreationResult":{"properties":{"id":{"description":"The identifier of the resource that this result is referencing.","minLength":1,"type":"string"},"index":{"description":"The index of the item in the input list.","minimum":0,"type":"integer"},"reason":{"description":"A human readable reason giving more details regarding this result.","minLength":1,"type":"string"}},"required":["id","index"],"type":"object"},"AdPaymentsCountryCode":{"description":"Enum defining country codes.","enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","UK","US","ZA"],"type":"string"},"AdPaymentsCountryCodeList":{"description":"A list of country codes.","items":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"minItems":0,"type":"array"},"AdPaymentsCreatePaymentAgreementsInput":{"description":"Represents the input of the create payment agreement API.","properties":{"paymentAgreements":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementList"}},"required":["paymentAgreements"],"type":"object"},"AdPaymentsCreatePaymentAgreementsOutput":{"description":"Represent the output of the create payment agreement API.","properties":{"error":{"items":{"$ref":"#/components/schemas/AdPaymentsBulkCreationResult","properties":{}},"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdPaymentsBulkCreationResult","properties":{}},"type":"array"}},"required":["error","success"],"type":"object"},"AdPaymentsCreatePaymentProfileInput":{"description":"Represents the input of the create payment profiles API.","properties":{"paymentProfiles":{"$ref":"#/components/schemas/AdPaymentsPaymentProfileList"}},"required":["paymentProfiles"],"type":"object"},"AdPaymentsCreatePaymentProfilesOutput":{"description":"Represent the output of the create payment profiles API.","properties":{"error":{"items":{"$ref":"#/components/schemas/AdPaymentsBulkCreationResult","properties":{}},"type":"array"},"success":{"items":{"$ref":"#/components/schemas/AdPaymentsBulkCreationResult","properties":{}},"type":"array"}},"required":["error","success"],"type":"object"},"AdPaymentsCreditCardPaymentMethod":{"description":"Represents Credit Card payment method structure.","properties":{"brand":{"description":"The processor used to execute payments on the card, such as Visa, MasterCard, etc. Only valued for credit card payment methods.","minLength":1,"type":"string"},"eligibleCountries":{"$ref":"#/components/schemas/AdPaymentsCountryCodeList"},"expiryDetails":{"$ref":"#/components/schemas/AdPaymentsExpiryDetails"},"instrumentId":{"description":"Identifies a credit card payment method.","minLength":1,"type":"string"},"tail":{"description":"The last four digits of the credit card number.","type":"string"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"}},"required":["brand","eligibleCountries","expiryDetails","instrumentId","tail","type"],"type":"object"},"AdPaymentsCreditCardPaymentMethodList":{"description":"A list of credit card payment methods.","items":{"$ref":"#/components/schemas/AdPaymentsCreditCardPaymentMethod"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsCurrencyAmount":{"properties":{"amount":{"description":"A monetary amount.","minLength":1,"type":"number"},"currencyCode":{"$ref":"#/components/schemas/AdPaymentsCurrencyCode"}},"required":["amount","currencyCode"],"type":"object"},"AdPaymentsCurrencyCode":{"description":"Enum defining different currency codes.","enum":["AED","AUD","BRL","CAD","CLP","COP","EGP","EUR","GBP","INR","JPY","MXN","NGN","PLN","SAR","SEK","SGD","TRY","USD","ZAR"],"type":"string"},"AdPaymentsDeductFromPaymentPaymentMethod":{"description":"Represents DeductFromPayment payment method structure. DeductFromPayment is a type of payment method where spends are deducted from vendor balance of a particular vendor code.","properties":{"countryCode":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"eligibleCountries":{"$ref":"#/components/schemas/AdPaymentsCountryCodeList"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"},"vendorCode":{"description":"A vendor code identifies a product being sold by a vendor on the retail website. When Amazon purchases products from a vendor, Amazon owes the vendor money which gets added to the vendor''s balance. An advertising account can then use this balance to pay for their advertising spends.","minLength":1,"type":"string"},"vendorCodeBalance":{"$ref":"#/components/schemas/AdPaymentsCurrencyAmount"},"vendorCodeName":{"description":"The name of the vendor code this payment method represents.","minLength":1,"type":"string"},"vendorGroupId":{"description":"The identifier of the vendor group that this vendor code belongs to.","minLength":1,"type":"string"}},"required":["eligibleCountries","type","vendorCode","vendorCodeName"],"type":"object"},"AdPaymentsDeductFromPaymentPaymentMethodList":{"description":"A list of deduct from payment payment methods.","items":{"$ref":"#/components/schemas/AdPaymentsDeductFromPaymentPaymentMethod"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsDirectDebitPaymentMethod":{"description":"Represents Direct Debit payment method structure.","properties":{"eligibleCountries":{"$ref":"#/components/schemas/AdPaymentsCountryCodeList"},"instrumentId":{"description":"Identifies a direct debit payment method.","minLength":1,"type":"string"},"tail":{"description":"The last four digits of the bank account number.","type":"string"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"}},"required":["eligibleCountries","instrumentId","tail","type"],"type":"object"},"AdPaymentsDirectDebitPaymentMethodList":{"description":"A list of direct debit payment methods.","items":{"$ref":"#/components/schemas/AdPaymentsDirectDebitPaymentMethod"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsEntityMarketplace":{"description":"Represents an advertiser and marketplace combination.","properties":{"countryCode":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"entityId":{"description":"The identifier of the entity.","minLength":1,"type":"string"},"entityType":{"$ref":"#/components/schemas/AdPaymentsEntityType"}},"required":["entityId","entityType"],"type":"object"},"AdPaymentsEntityMarketplaceList":{"description":"A list of uniquely identifiable advertising entities.","items":{"$ref":"#/components/schemas/AdPaymentsEntityMarketplace"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsEntityType":{"description":"Enum defining different advertiser types.","enum":["AGENCY","DSP_ADVERTISING_ACCOUNT","GLOBAL_ACCOUNT","MANAGER_ACCOUNT","SELLER","VENDOR"],"type":"string"},"AdPaymentsError":{"properties":{"code":{"type":"string"},"details":{"type":"string"}},"required":["code","details"],"type":"object"},"AdPaymentsExpiryDetails":{"description":"Indicates the month a payment method will expire.","properties":{"month":{"description":"The month the payment method will expire.","type":"integer"},"year":{"description":"The year the payment method will expire.","type":"integer"}},"required":["month","year"],"type":"object"},"AdPaymentsGetCustomerPaymentMethodsOutput":{"description":"Represents the output of the get payment methods API.","properties":{"creditCardPaymentMethods":{"$ref":"#/components/schemas/AdPaymentsCreditCardPaymentMethodList"},"deductFromPaymentPaymentMethods":{"$ref":"#/components/schemas/AdPaymentsDeductFromPaymentPaymentMethodList"},"directDebitPaymentMethods":{"$ref":"#/components/schemas/AdPaymentsDirectDebitPaymentMethodList"},"nextToken":{"$ref":"#/components/schemas/AdPaymentsNextToken"},"payByInvoicePaymentMethods":{"$ref":"#/components/schemas/AdPaymentsPayByInvoicePaymentMethodList"},"sellerPayablePaymentMethods":{"$ref":"#/components/schemas/AdPaymentsSellerPayablePaymentMethodList"}},"type":"object"},"AdPaymentsGetPaymentAgreementOutput":{"description":"Represent the output of the get payment agreements API.","properties":{"nextToken":{"$ref":"#/components/schemas/AdPaymentsNextToken"},"paymentAgreements":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementList"}},"required":["paymentAgreements"],"type":"object"},"AdPaymentsIdempotenceId":{"description":"Idempotency Id that will be used as a identifier to ensure idempotency while creating /updating the given resource. Requests with same idempotency Id will be considered identical and processed in an idempotent manner.","minLength":1,"type":"string"},"AdPaymentsLocale":{"description":"Enum defining supported language locales.","enum":["ar_AE","de_DE","en_AU","en_CA","en_GB","en_IN","en_SG","en_US","es_CO","es_ES","es_MX","es_US","fr_CA","fr_FR","hi_IN","it_IT","ja_JP","ko_KR","nl_NL","pl_PL","pt_BR","sv_SE","ta_IN","th_TH","tr_TR","vi_VN","zh_CN","zh_TW"],"type":"string"},"AdPaymentsNextToken":{"description":"To retrieve the next page of results, call the same operation and specify this token in the request. If the nextToken field is empty, there are no further results.","type":"string"},"AdPaymentsPayByInvoicePaymentMethod":{"description":"Represents Pay By Invoice payment method structure. Pay By Invoice is a type of payment method where the customer receives a physical invoice which they can pay via bank transfer.","properties":{"eligibleCountries":{"$ref":"#/components/schemas/AdPaymentsCountryCodeList"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"}},"required":["eligibleCountries","type"],"type":"object"},"AdPaymentsPayByInvoicePaymentMethodList":{"description":"A list of pay by invoice payment methods.","items":{"$ref":"#/components/schemas/AdPaymentsPayByInvoicePaymentMethod"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsPayInvoicesInput":{"description":"Represents the input to the pay invoices API.","properties":{"idempotenceId":{"$ref":"#/components/schemas/AdPaymentsIdempotenceId"},"paymentAgreementId":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementId"},"reasonLocale":{"$ref":"#/components/schemas/AdPaymentsLocale"}},"required":["idempotenceId"],"type":"object"},"AdPaymentsPayInvoicesOutput":{"description":"Represents the output of the pay invoices API.","properties":{"failure":{"$ref":"#/components/schemas/AdPaymentsPaymentResultList"},"success":{"$ref":"#/components/schemas/AdPaymentsPaymentResultList"}},"required":["failure","success"],"type":"object"},"AdPaymentsPaymentAgreement":{"description":"Represents an agreement between two parties indicating what profile to use during payment execution.","properties":{"paymentAgreementId":{"description":"The ID associated to this payment agreement.","minLength":1,"type":"string"},"paymentProfile":{"$ref":"#/components/schemas/AdPaymentsPaymentProfile"},"target":{"$ref":"#/components/schemas/AdPaymentsTarget"}},"required":["paymentProfile","target"],"type":"object"},"AdPaymentsPaymentAgreementId":{"description":"ID of a payment agreement that must belong to the customer. A one-time payment will be collected using the payment agreement's associated payment profile. If not provided, the latest payment agreement of the advertiser will be used to collect payments.","minLength":1,"type":"string"},"AdPaymentsPaymentAgreementList":{"items":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreement"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsPaymentAgreementType":{"description":"Enum defining different Payment Agreement types.","enum":["AUTO_PAY","PAY_NOW"],"type":"string"},"AdPaymentsPaymentMethod":{"description":"Represents a payment method.","properties":{"brand":{"description":"The processor used to execute payments on the card, such as Visa, MasterCard, etc. Only valued for credit card payment methods.","minLength":1,"type":"string"},"countryCode":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"expiryDetails":{"$ref":"#/components/schemas/AdPaymentsExpiryDetails"},"instrumentId":{"description":"Identifies a credit card or direct debit payment method.","minLength":1,"type":"string"},"priority":{"description":"A numerical priority assigned to each payment method within a given profile, dictating the sequential order in which these payment methods are utilized during payment execution. Lower numerical values indicate higher priority, with the option possessing the lowest value being selected first.","type":"integer"},"sellerAccountId":{"description":"The seller account ID associated to this payment method, only valued for seller payable payment methods.","minLength":1,"type":"string"},"tail":{"description":"The last four digits of a credit card or bank account number.","type":"string"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"},"vendorCode":{"description":"The vendor code associated to this payment method, only valued for deduct from payment payment methods.","minLength":1,"type":"string"},"vendorCodeBalance":{"$ref":"#/components/schemas/AdPaymentsCurrencyAmount"},"vendorCodeName":{"description":"The name of the vendor code this payment method represents.","minLength":1,"type":"string"}},"required":["priority","type"],"type":"object"},"AdPaymentsPaymentMethodList":{"items":{"$ref":"#/components/schemas/AdPaymentsPaymentMethod"},"maxItems":100,"minItems":1,"type":"array"},"AdPaymentsPaymentMethodType":{"description":"Enum defining different PaymentMethod.","enum":["CREDIT_CARD","DEDUCT_FOR_PAYMENT","DIRECT_DEBIT","PAY_BY_INVOICE","SELLER_PAYABLE"],"type":"string"},"AdPaymentsPaymentProfile":{"description":"Represents a list of payment methods and the scope of advertisers able to access them.","properties":{"defaultFor":{"$ref":"#/components/schemas/AdPaymentsEntityMarketplaceList"},"eligibleEntities":{"$ref":"#/components/schemas/AdPaymentsEntityMarketplaceList"},"paymentMethods":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodList"},"paymentProfileId":{"description":"The ID associated to this payment profile.","minLength":1,"type":"string"}},"type":"object"},"AdPaymentsPaymentProfileList":{"items":{"$ref":"#/components/schemas/AdPaymentsPaymentProfile"},"maxItems":100,"minItems":1,"type":"array"},"AdPaymentsPaymentResult":{"description":"Represents the result of a payment execution.","properties":{"invoiceCFID":{"description":"The customer facing ID of the invoice.","minLength":1,"type":"string"},"reason":{"description":"A human-readable reason explaining the payment result.","minLength":1,"type":"string"}},"required":["invoiceCFID"],"type":"object"},"AdPaymentsPaymentResultList":{"items":{"$ref":"#/components/schemas/AdPaymentsPaymentResult"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsSellerPayablePaymentMethod":{"description":"Represents Seller Payable payment method structure. Seller Payable is a type of payment method where spends are deducted from the seller balance of a particular seller account.","properties":{"countryCode":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"eligibleCountries":{"$ref":"#/components/schemas/AdPaymentsCountryCodeList"},"sellerAccountId":{"description":"The seller account ID associated to this payment method","minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/AdPaymentsPaymentMethodType"}},"required":["eligibleCountries","type"],"type":"object"},"AdPaymentsSellerPayablePaymentMethodList":{"description":"A list of seller payable payment methods.","items":{"$ref":"#/components/schemas/AdPaymentsSellerPayablePaymentMethod"},"maxItems":100,"minItems":0,"type":"array"},"AdPaymentsTarget":{"properties":{"agreementType":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementType"},"countryCode":{"$ref":"#/components/schemas/AdPaymentsCountryCode"},"entityId":{"description":"The ID associated to the entity in this target.","minLength":1,"type":"string"},"entityType":{"$ref":"#/components/schemas/AdPaymentsEntityType"}},"required":["agreementType","countryCode"],"type":"object"},"ApplyBillingProfileRequest":{"description":"Request with a list of advertisers to which a list of billing profiles needs to be applied.","properties":{"billingProfileUsages":{"description":"List of advertisers to which a list of billing profiles needs to be applied.","items":{"properties":{"advertiser":{"$ref":"#/components/schemas/MarketplaceAdvertiser"},"billingProfileIds":{"description":"List of billing profile identifiers which needs to be associated with an advertiser.","items":{"type":"string"},"maxItems":2,"minItems":1,"type":"array"}},"required":["advertiser","billingProfileIds"],"type":"object"},"maxItems":20,"minItems":0,"type":"array"}},"required":["billingProfileUsages"],"type":"object"},"ApplyBillingProfileResponse":{"description":"Contains a list of one or more responses corresponding to each advertiser and applied billing profile(s).","properties":{"billingProfileUsages":{"description":"Segregated list of success and error responses for each country and applied billing profile(s).","properties":{"error":{"description":"Error responses for each country and applied billing profile.","items":{"type":"object"},"maxItems":30,"minItems":0,"properties":{},"type":"array"},"success":{"description":"Success responses for each country and applied billing profile(s).","items":{"type":"object"},"maxItems":30,"minItems":0,"properties":{},"type":"array"}},"type":"object"}},"type":"object"},"AvailableDocumentResponse":{"properties":{"contentType":{"type":"string"},"docType":{"$ref":"#/components/schemas/DocType"},"fileName":{"type":"string"},"storagePath":{"type":"string"}},"type":"object"},"BaseBillingProfile":{"description":"Billing profile object which contains details regarding address, tax, etc.","properties":{"address":{"description":"Address details to be used for a billing profile","properties":{"addressLine1":{"maxLength":60,"type":"string"},"addressLine2":{"maxLength":60,"type":"string"},"addressLine3":{"maxLength":60,"type":"string"},"billingName":{"description":"The name of the person or organization who is going to recieve the invoice","maxLength":50,"type":"string"},"city":{"maxLength":50,"type":"string"},"contactName":{"description":"Contact name for the billing profile which will also be printed on the invoice.","maxLength":50,"type":"string"},"countryCode":{"type":"string"},"faxNumber":{"maxLength":100,"type":"string"},"phoneNumber":{"maxLength":100,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"primaryEmail":{"type":"string"},"secondaryEmails":{"items":{"maxLength":64,"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"stateOrRegion":{"maxLength":50,"type":"string"}},"required":["addressLine1","billingName","city","contactName","countryCode","primaryEmail"],"type":"object"},"agreements":{"description":"List of tax-type and corresponding details.","items":{"properties":{"consent":{"default":"false","description":"Consent on the provided agreement document.","type":"boolean"},"documentName":{"description":"Agreement document name against which consent needs to be provided. The content of the agreement can be checked by providing agreement name in `POST /billingProfileAgreementContents/{billingProfileAgr...","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["consent","documentName"],"type":"object"},"type":"array"},"billingProfileName":{"description":"Name of a billing profile. This name will only be used to identify the billing profile and will not be used for billing. This is for the client to organize the billing profiles and doesn't affect the billing process.","type":"string"},"displayInfo":{"description":"Object determines publicly displayed information about the advertiser","properties":{"displayName":{"description":"Relevant for only authors. Required if author chooses displayNameField as DISPLAY_NAME.The value inside this field will be shown publicly.","maxLength":100,"type":"string"},"displayNameField":{"description":"Determines the name field that will be displayed publicly.For non-authors, the default and only allowed value for this is BILLING_NAME.","enum":["BILLING_NAME","DISPLAY_NAME"],"type":"string"}},"type":"object"},"holdingCompany":{"description":"Type of holding company for agency billing profile. Agency Holding Companies are conglomerate entities that own multiple smaller advertising agencies.","type":"string"},"isDefault":{"default":"false","description":"Attribute to indicate if a billing profile is default or not under that global account. Once marked as default, for new countries this billing profile will get automatically applied, if all information provided are sufficient","type":"boolean"},"purchaseOrderNumber":{"description":"Number to track spend against the budgeted amounts.","maxLength":64,"type":"string"},"taxes":{"description":"List of tax-type and values.","items":{"properties":{"countryCode":{"description":"Code of the country to which the tax value belongs to which would override the countryCode provided in the address.","type":"string"},"type":{"description":"Type of tax. Check following table for supported tax types: <br/><br/><table border=1><caption> **Supported Tax Types** </caption><tr> <th>Tax Type</th> </tr><tr> <td>VAT</td> </tr><tr> <t...","type":"string"},"value":{"description":"Value of the tax type. For example, VAT number for VAT tax type, etc.","type":"string"}},"required":["type","value"],"type":"object"},"maxItems":10,"minItems":0,"type":"array"}},"required":["address","billingParty","billingProfileName","isBillTo","purchaseOrderNumber"],"type":"object"},"BillingInvoiceSummariesRequest":{"description":"Payload with filter, sort and aggregate key(s) to fetch list of billing invoice summary(s).","properties":{"aggregation":{"description":"Object encapsulating the aggregation query information","properties":{"attribute":{"description":"Aggregation attribute for the billing invoice summary(s)","type":"string"},"groupBy":{"description":"Aggregation bucket for the billing invoice summary(s)","type":"string"},"operation":{"description":"Aggregate operation for the billing invoice summary(s)","type":"string"}},"type":"object"},"countryValueFilter":{"description":"Object encapsulating the country filtering information","properties":{"include":{"description":"List of country value(s) to filter from the list of billing invoice summary(s).","items":{"type":"string"},"maxItems":30,"minItems":0,"type":"array"},"queryTermMatchType":{"description":"Defines how would the string resource field be matched with the query term in filter.","type":"string"}},"type":"object"},"invoiceDueDateRangeFilter":{"description":"Object encapsulating due date range information","properties":{"endDate":{"description":"The ending due date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","format":"date","type":"string"},"startDate":{"description":"The starting due date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","format":"date","type":"string"}},"type":"object"},"invoiceIssuedDateRangeFilter":{"description":"Object encapsulating issued date range information","properties":{"endDate":{"description":"The ending issued date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","format":"date","type":"string"},"startDate":{"description":"The starting issued date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","format":"date","type":"string"}},"type":"object"},"invoiceNumberFilter":{"description":"Object encapsulating the invoice number search information","properties":{"include":{"description":"List of invoice number(s) to filter from the list of billing invoice summary(s).","items":{"type":"string"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"maxResults":{"default":"100","description":"Max results / billing invoice summary(s) to be shown in a single page.","format":"int64","type":"integer"},"nextToken":{"description":"Offset to fetch next page with list of billing invoice summary(s).","type":"string"},"paymentMethodTypeValueFilter":{"description":"Object encapsulating the payment method type filtering information against which invoice is issued","properties":{"include":{"description":"List of payment method type value(s) to filter from the list of billing invoice summary(s).","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"queryTermMatchType":{"description":"Defines how would the string resource field be matched with the query term in filter.","type":"string"}},"type":"object"},"reserveOrderNumberFilter":{"description":"Object encapsulating the reserve order number search information","properties":{"include":{"description":"List of reserve order number(s) to filter from the list of billing invoice summary(s).","items":{"type":"string"},"maxItems":30,"minItems":0,"type":"array"}},"type":"object"},"sort":{"description":"Object encapsulating the sort operation information","properties":{"attribute":{"description":"Sort key or attribute for the list of billing invoice summary(s)","type":"string"},"direction":{"description":"Sort order(ascending or descending) for list of billing invoice summary(s)","type":"string"}},"type":"object"},"statusValueFilter":{"description":"Object encapsulating the invoice status filtering information","properties":{"include":{"description":"List of invoice status value(s) to filter from the list of billing invoice summary(s).","items":{"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"queryTermMatchType":{"description":"Defines how would the string resource field be matched with the query term in filter.","type":"string"}},"type":"object"}},"type":"object"},"BillingInvoiceSummariesResponse":{"description":"Contains an object encapsulating either the aggregation result(s) or sorted & filtered billing invoice summary(s).","properties":{"aggregation":{"description":"Object encapsulating the aggregation query and result(s) information","properties":{"invoiceSummaries":{"description":"List of object(s) encapsulating information of billing invoice summary(s).","items":{"$ref":"#/components/schemas/BillingInvoiceSummary","type":"object"},"properties":{},"type":"array"},"results":{"description":"Object encapsulating the aggregation result as per aggregation attribute, operation and bucket (or groupById) on the list of billing invoice summary(s).","items":{"type":"object"},"properties":{},"type":"array"}},"type":"object"},"nextToken":{"description":"Offset to fetch next page with list of billing invoice summary(s).","type":"string"}},"type":"object"},"BillingInvoiceSummary":{"description":"Object encapsulating billing invoice summary information","properties":{"amountDue":{"$ref":"#/components/schemas/CurrencyAmount","description":"Object identifies the amount due along with currency code for the invoice","type":"object"},"country":{"description":"Object encapsulating billing invoice country information","properties":{"code":{"description":"Country code for the invoice","properties":{},"type":"string"},"value":{"description":"Country name for the invoice","properties":{},"type":"string"}},"type":"object"},"dueDate":{"description":"Invoice due date in ISO-8601 format, representing a UTC date with only the date portion (no time)","format":"date","type":"string"},"ePaymentStatus":{"description":"Object encapsulating e-payment status for the invoice","properties":{"code":{"description":"e-payment status code for the invoice","properties":{},"type":"string"},"value":{"description":"e-payment status for the invoice","properties":{},"type":"string"}},"type":"string"},"id":{"description":"Billing Document Number","type":"string"},"issuedDate":{"description":"Invoice issued date in ISO-8601 format, representing a UTC date with only the date portion (no time)","format":"date","type":"string"},"paymentMethodType":{"description":"Object encapsulating payment method type against which invoice is issued","properties":{"code":{"description":"Payment method type for the invoice code","properties":{},"type":"string"},"value":{"description":"Payment method type for the invoice","properties":{},"type":"string"}},"type":"string"},"refundDetails":{"description":"Object encapsulating the invoice refund information","properties":{"amount":{"$ref":"#/components/schemas/CurrencyAmount","description":"Object identifies the refunded amount along with currency code for the invoice","properties":{},"type":"object"},"reason":{"description":"Refund reason of the invoice","properties":{},"type":"string"},"status":{"description":"Refund status of the invoice","properties":{},"type":"string"}},"type":"object"},"remainingAmountDue":{"$ref":"#/components/schemas/CurrencyAmount","description":"Object identifies the remaining amount due along with currency code for the invoice","type":"object"},"reserveOrderNumber":{"description":"Reserve Order Number","type":"string"},"status":{"description":"Object encapsulating billing invoice summary status information","properties":{"code":{"description":"Invoice summary status code","properties":{},"type":"string"},"description":{"description":"Invoice summary status description","properties":{},"type":"string"},"value":{"description":"Invoice summary status","properties":{},"type":"string"}},"type":"string"},"statusDecorator":{"description":"Object encapsulating billing invoice summary status decorator information","properties":{"code":{"description":"Invoice summary status decorator code","properties":{},"type":"string"},"value":{"description":"Invoice summary status decorator","properties":{},"type":"string"}},"type":"string"}},"type":"string"},"BillingProfile":{"allOf":[{"$ref":"#/components/schemas/BaseBillingProfile"},{"properties":{"billingParty":{"description":"Choose `AGENCY` if you are an agency representing an advertiser. Choose `BRAND_OWNER` if you are advertising for your product's sales.","properties":{},"type":"string"},"billingProfileId":{"description":"Billing profile identifier which will be used to identify a billing profile. This identifier will NOT affect billing process.","properties":{},"type":"string"},"isBillTo":{"description":"Whether the billingProfile created should be used for invoicing, taxation and other billing workflows.","properties":{},"type":"boolean"}},"required":["billingParty","billingProfileId","isBillTo"],"type":"object"}],"description":"Billing profile object which contains details regarding address, tax, etc.","type":"object"},"BillingProfileAgreementContentResponse":{"properties":{"content":{"description":"An HTML document to be rendered and read. A consent needs to be provided against this content.","type":"string"}},"type":"object"},"BillingProfileErrorResponse":{"description":"Contains the machine-readable error code and human-readable details.","properties":{"code":{"description":"The code describing the error reason.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"BillingProfileStatus":{"description":"Current Status of the link between the billing Profile and the country. The following table defines the statuses and their descriptions.","properties":{"statusCode":{"type":"string"},"statusMessage":{"type":"string"}},"type":"object"},"BillingProfileUsage":{"description":"This object contains billing profile(s) that is applied to a given country under a global account","properties":{"advertiser":{"$ref":"#/components/schemas/MarketplaceAdvertiser"},"billingProfileUsageId":{"description":"Billing profile usage unique identifier.","type":"string"},"billingProfiles":{"items":{"$ref":"#/components/schemas/BillingProfile","properties":{}},"maxItems":2,"minItems":0,"type":"array"},"fallbackBillingProfiles":{"items":{"$ref":"#/components/schemas/BillingProfile","properties":{}},"maxItems":1,"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/BillingProfileStatus"}},"type":"object"},"BillingStatementErrorResponse":{"properties":{"billingStatementRequestId":{"description":"Billing statement request identifier.","type":"string"},"code":{"description":"The code describing the error reason.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"CountryCode":{"enum":["AE","AU","BE","BR","CA","CL","CO","DE","EG","ES","FR","IE","IN","IT","JP","MX","NG","NL","PL","SA","SE","SG","TR","UK","US","ZA"],"type":"string"},"CreateBillingProfile":{"allOf":[{"$ref":"#/components/schemas/BaseBillingProfile"},{"properties":{"billingParty":{"description":"Choose `AGENCY` if you are an agency representing an advertiser. Choose `BRAND_OWNER` if you are advertising for your product's sales","type":"string"},"isBillTo":{"description":"Whether the billingProfile created should be used for invoicing, taxation and other billing workflows.","type":"boolean"}},"required":["billingParty","isBillTo"],"type":"object"}],"description":"Object encapsulating information for creating a billing profile","type":"object"},"CreateBillingProfilesRequest":{"description":"Contains a list of one or more billing profiles to be created.","properties":{"billingProfiles":{"items":{"$ref":"#/components/schemas/CreateBillingProfile"},"maxItems":100,"minItems":0,"type":"array"}},"required":["billingProfiles"],"type":"object"},"CreateBillingStatementRequest":{"properties":{"countryCodes":{"description":"List of countries for which billing statements are to be fetched. If no country codes are passed in the request, the statement will be generated for all the advertising countries by default.","items":{"$ref":"#/components/schemas/CountryCode","type":"string"},"maxItems":30,"minItems":0,"type":"array"},"endDate":{"description":"End date of the invoice summary period for a report in the format YYYY-MM-DD.","format":"date","pattern":"/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/","type":"string"},"format":{"default":"CSV","description":"Format of the file, such as, for billing statements, etc.","enum":["CSV"],"type":"string","x-amazon-advertising-package":"AdvertisingBillingApiService"},"locale":{"description":"Preferred locale can be chosen among the list of valid language codes. Check the table below for supported language code.","type":"string","x-amazon-advertising-package":"AdvertisingBillingApiService"},"startDate":{"description":"Start date of the invoice summary period for a report in the format YYYY-MM-DD.","format":"date","pattern":"/([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/","type":"string"}},"required":["endDate","locale","startDate"],"type":"object"},"CreateBillingStatementResponse":{"properties":{"billingStatementRequestId":{"description":"Billing statement request identifier.","type":"string"},"details":{"description":"A human-readable description of the response.","type":"string"}},"type":"object"},"CreateOrUpdateBillingProfilesResponse":{"description":"Contains a list of one or more responses corresponding to each billing profile along with index.","properties":{"billingProfiles":{"description":"Segregated list of success and error responses for each billing profile in request payload.","properties":{"error":{"description":"List of error responses for each billing profile in request payload.","items":{"type":"object"},"maxItems":100,"minItems":0,"properties":{},"type":"array"},"success":{"description":"List of success responses for each billing profile in request payload.","items":{"type":"object"},"maxItems":100,"minItems":0,"properties":{},"type":"array"}},"type":"object"}},"type":"object"},"CurrencyAmount":{"description":"Identifies the amount along with currency code.","properties":{"amount":{"type":"number"},"currencyCode":{"type":"string"}},"required":["amount","currencyCode"],"type":"object"},"DocType":{"description":"Supported type of billing document to be specified through query parameter. \nPrepayment Receipts do not share the same documentId as the other DocTypes and must be requested separately.","enum":["CREDIT_MEMO","GIS_CREDIT_MEMO","GIS_INVOICE","INVOICE","PAYMENT_COMPLEMENT","PREPAYMENT_RECEIPT"],"type":"string"},"GetBillingProfileUsageRequest":{"description":"The request body to fetch billing profiles linked to each country of global ads account.","properties":{"expandBillingProfile":{"default":"false","description":"By default only the billingProfileId linked to the country will be returned. Choose `true` if you would like to see the content of the billing profiles linked to a country","type":"boolean"},"expandFallbackBillingProfile":{"default":"false","description":"Choose `true` if you would like to see the information currently being used for billing for this marketplace.","type":"boolean"},"filters":{"description":"Filter object to be used to fetch list of billing profile usage(s).","properties":{"advertiserFilter":{"description":"Indicates list of advertiser identifiers(s) for which billing profile(s) needs to be fetched.","items":{"$ref":"#/components/schemas/MarketplaceAdvertiser"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"maxResults":{"default":"100","description":"Max results / billing profile usage(s) to be shown in a single page.","format":"int64","type":"integer"},"nextToken":{"description":"Offset to fetch next page with list of billing profile usage(s).","type":"string"}},"type":"object"},"GetBillingProfileUsageResponse":{"description":"Contains billing profile usages: list of advertisers and applied billing profile.","properties":{"billingProfileUsages":{"items":{"$ref":"#/components/schemas/BillingProfileUsage","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"default":"100","description":"Max results / billing profile usage(s) to be shown in a single page.","format":"int64","type":"integer"},"nextToken":{"description":"Indicates the pagination token to be used to access next page.","type":"string"}},"type":"object"},"GetBillingProfilesRequest":{"description":"Payload to fetch list of billing profile(s).","properties":{"filters":{"description":"Filter object to be used to fetch list of billing profile(s).","properties":{"billingProfileIdFilter":{"description":"Indicates list of billing profile identifier(s) for which billing profile(s) needs to be fetched.","items":{"type":"string"},"maxItems":20,"minItems":0,"type":"array"},"defaultBillingProfileFilter":{"default":"false","description":"Indicates if default billing profile needs to be fetched.","type":"boolean"}},"type":"object"},"maxResults":{"default":"100","description":"Max results / billing profile(s) to be shown in a single page.","format":"int64","type":"integer"},"nextToken":{"description":"Offset to fetch next page with list of billing profile(s).","type":"string"}},"type":"object"},"GetBillingProfilesResponse":{"description":"Paginated list of billing profile(s) response.","properties":{"billingProfiles":{"description":"Indicates list of billing profile(s).","items":{"$ref":"#/components/schemas/BillingProfile","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"maxResults":{"default":"100","description":"Max results / billing profile(s) to be shown in a single page.","format":"int64","type":"integer"},"nextToken":{"description":"Offset to fetch next page with list of billing profile(s).","type":"string"}},"type":"object"},"GetBillingStatementResponse":{"properties":{"details":{"description":"The human-readable description of the response.","type":"string"},"reportStatus":{"description":"The request status of the billing statement.","enum":["FAILED","IN_PROGRESS","SUCCESS"],"type":"string"},"s3DownloadLink":{"description":"Download link of the billing statement file. Only when reportStatus is SUCCESS.","type":"string"}},"type":"object"},"GetDocumentResponseContent":{"properties":{"availableDocuments":{"items":{"$ref":"#/components/schemas/AvailableDocumentResponse","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"unavailableDocuments":{"items":{"$ref":"#/components/schemas/UnavailableDocumentResponse","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"InternalServerExceptionResponseContent":{"description":"Thrown when service encounters unexpected error during processing of request.","properties":{"code":{"description":"Error Code.","minLength":1,"type":"string"},"message":{"description":"Human readable response message.","minLength":1,"type":"string"}},"required":["code","message"],"type":"object"},"Locale":{"description":"Preferred locale can be chosen among the list of valid language codes. Check the table below for supported language code.","type":"string"},"MarketplaceAdvertiser":{"description":"Represents one country inside a global account","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"}},"required":["countryCode"],"type":"object"},"ResourceNotFoundExceptionResponseContent":{"description":"Request references a resource which does not exist.","properties":{"code":{"description":"Error Code.","minLength":1,"type":"string"},"message":{"description":"Human readable response message.","minLength":1,"type":"string"}},"required":["code","message"],"type":"object"},"UnauthorizedExceptionResponseContent":{"properties":{"code":{"description":"Error Code.","minLength":1,"type":"string"},"message":{"description":"Human readable response message.","minLength":1,"type":"string"}},"required":["code","message"],"type":"object"},"UnavailableDocumentResponse":{"properties":{"contentType":{"type":"string"},"docType":{"$ref":"#/components/schemas/DocType"},"fileName":{"type":"string"},"reason":{"type":"string"},"storagePath":{"type":"string"}},"type":"object"},"UpdateBillingProfile":{"allOf":[{"$ref":"#/components/schemas/BaseBillingProfile"},{"properties":{"billingProfileId":{"description":"Billing profile identifier which will be used to identify a billing profile. This identifier will NOT affect billing process.","type":"string"}},"required":["billingProfileId"],"type":"object"}],"description":"Object encapsulating information for updating a billing profile","type":"object"},"UpdateBillingProfilesRequest":{"description":"Contains a list of one or more billing profiles to be updated.","properties":{"billingProfiles":{"items":{"$ref":"#/components/schemas/UpdateBillingProfile"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"ValidationExceptionResponseContent":{"description":"The input fails to satisfy the constraints specified by an Advertising API service.","properties":{"code":{"description":"Error Code.","minLength":1,"type":"string"},"message":{"description":"Human readable response message.","minLength":1,"type":"string"}},"required":["code","message"],"type":"object"},"adProgram":{"description":"Sponsored Ads only. This field indicates the ad type (such as Sponsored Products, Sponsored Brands or Sponsored Display).\n","enum":["AMAZON LIVE","CREATOR CONNECTIONS","SPONSORED BRANDS","SPONSORED DISPLAY","SPONSORED DISPLAY FOR FIRE TV","SPONSORED PRODUCT"],"type":"string"},"address":{"properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"attentionName":{"type":"string"},"city":{"type":"string"},"companyName":{"type":"string"},"countryCode":{"$ref":"#/components/schemas/countryCode"},"postalCode":{"type":"string"},"stateOrRegion":{"type":"string"}},"required":["addressLine1","addressLine2","addressLine3","city","companyName","countryCode","postalCode","stateOrRegion"],"type":"object"},"adjustment":{"properties":{"accountingDate":{"$ref":"#/components/schemas/date"},"amount":{"$ref":"#/components/schemas/currencyAmount"},"comments":{"type":"string"},"fees":{"description":"Charges can include different fees (see feeType below).\n","items":{"$ref":"#/components/schemas/fee","properties":{}},"type":"array"},"portfolioId":{"description":"Sponsored Ads only. This identifier maps to one of the portfolios listed in the portfolios section.\n","format":"int64","type":"integer"}},"required":["accountingDate","amount"],"type":"object"},"adjustments":{"description":"List of adjustments (positive and negative) applied to this invoice.","items":{"$ref":"#/components/schemas/adjustment"},"type":"array"},"advertiserMarketplace":{"properties":{"advertiserId":{"type":"string"},"advertiserType":{"$ref":"#/components/schemas/advertiserTypes"},"marketplaceId":{"type":"string"}},"required":["advertiserId","marketplaceId"],"type":"object"},"advertiserTypes":{"enum":["AGENCY","DSP_ADVERTISING_ACCOUNT","SELLER","VENDOR"],"type":"string"},"billingAggregation":{"properties":{"billingAggregationId":{"description":"An identifier that helps associate this invoice with specific billing entities, such as campaigns or rodeo advertiser accounts.","type":"string"},"billingAggregationResourcePath":{"description":"The resource path to suffix to the base URL endpoints to retrieve the corresponding billing aggregation entity, such as a specific campaign or all active campaigns under DSP Rodeo Advertiser.","type":"string"},"billingLevel":{"$ref":"#/components/schemas/billingLevel"}},"type":"object"},"billingLevel":{"description":"Configured on the Rodeo portal and only applicable to ADSP-SS, this flag reflects the basis on which campaigns are consolidated. Possible values include:\n- 'CAMPAIGN': Billing is based on individual campaigns. \n- 'ACCOUNT': Billing is based on the Rodeo DSP advertiser account.","enum":["ACCOUNT","CAMPAIGN"],"type":"string"},"billingNotification":{"properties":{"advertiserMarketplaces":{"items":{"$ref":"#/components/schemas/advertiserMarketplace","properties":{}},"maxItems":30,"minItems":1,"type":"array"},"description":{"type":"string"},"impact":{"$ref":"#/components/schemas/billingNotificationImpact"},"notificationName":{"$ref":"#/components/schemas/billingNotificationNames"},"paymentDueDate":{"format":"date-time","type":"string"},"priority":{"format":"int32","type":"integer"},"severity":{"$ref":"#/components/schemas/billingNotificationSeverity"},"suspensionDate":{"format":"date-time","type":"string"},"title":{"type":"string"}},"required":["description","impact","notificationName","priority","severity","title"],"type":"object"},"billingNotificationImpact":{"enum":["CAMPAIGNS_SUSPENDED","NO_IMPACT"],"type":"string"},"billingNotificationNames":{"enum":["ACCOUNT_ERROR","ACCOUNT_ERROR_IN_SELLER","AUTHOR_REGISTRATION_NOT_FOUND","BAD_DEBT_SUSPENSION","BILLING_ADDRESS_REGISTRATION_NOT_FOUND","BILLING_PROFILE_ERROR","BILLING_PROFILE_INVALID_DSA_INFO","BILLING_PROFILE_INVALID_PERMISSION","BILLING_PROFILE_INVALID_TAX","CNPJ_VERIFICATION_IN_PROGRESS","CREDIT_CARD_ALLOWED_AMOUNT_FAILURE","CREDIT_CARD_AUTHENTICATION_FAILURE","CREDIT_CARD_AUTHORIZATION_FAILURE","CREDIT_CARD_AUTH_EXPIRED_FAILURE","CREDIT_CARD_CHARGE_DISPUTE_CAUSED_SUSPENSION","CREDIT_CARD_CLOSED_FAILURE","CREDIT_CARD_EXPIRED","CREDIT_CARD_EXPIRES_SOON","CREDIT_CARD_GENERIC_FAILURE","CREDIT_CARD_INELIGIBLE_CARD","CREDIT_CARD_INELIGIBLE_SHARED_CARD","CREDIT_CARD_INSUF_BAL","CREDIT_CARD_INTERNAL_FAILURE","CREDIT_CARD_INVALID_ACCOUNT_FAILURE","CREDIT_CARD_INVALID_ADDRESS_FAILURE","CREDIT_CARD_INVALID_BANK_HOLDER_FAILURE","CREDIT_CARD_INVALID_CARD_FAILURE","CREDIT_CARD_INVALID_DETAILS","CREDIT_CARD_ISSUE_WITH_CARD","CREDIT_CARD_LOCKED_CARD","CREDIT_CARD_MFA_EXPIRED_FAILURE","CREDIT_CARD_PAYMENT_FAILURE_CAUSED_SUSPENSION","CREDIT_CARD_TRANSACTION_SIZE_FAILURE","CREDIT_CARD_VERIFICATION_FAILURE","CREDIT_CARD_VERIFICATION_FAILURE_CAUSED_SUSPENSION","CREDIT_CARD_VERIFICATION_PENDING","CREDIT_CARD_VOLUME_FAILURE","CREDIT_CARD_WITH_VERIFICATION_PAYMENT_FAILURE","CREDIT_CARD_WITH_VERIFICATION_PAYMENT_FAILURE_CAUSED_SUSPENSION","CREDIT_CARD_WITH_VERIFICATION_PENDING_CAUSED_SUSPENSION","CREDIT_CARD_WITH_VERIFICATION_SUSPENSION_WITH_PAYMENT_IN_PROGRESS","DEDUCT_FROM_PROCEEDS_PAYMENT_FAILURE_CAUSED_SUSPENSION","DEDUCT_FROM_PROCEEDS_WITH_CREDIT_CARD_FALLBACK_PAYMENT_FAILURE_CAUSED_SUSPENSION","DEDUCT_FROM_PROCEEDS_WITH_CREDIT_LIMIT_ELIGIBLE","DEDUCT_FROM_PROCEEDS_WITH_MONTHLY_INVOICE_ELIGIBLE","DIRECT_DEBIT_PAYMENT_PENDING","DPS_DENIED_PARTY","DPS_VERIFICATION_PENDING","INACTIVE_SELLER_ACCOUNT_CAUSED_SUSPENSION","INVALID_PAYMENT_REGISTRATION","MERCH_ON_DEMAND_REGISTRATION_NOT_FOUND","PAY_BY_INVOICE_OVERDUE_PAYMENT","PAY_BY_INVOICE_OVERDUE_PAYMENT_CAUSED_SUSPENSION","PAY_BY_INVOICE_OVERDUE_PAYMENT_PENDING_SUSPENSION","PAY_BY_INVOICE_UPCOMING_PAYMENT","PENDING_PAYMENT_REGISTRATION","PENDING_VALID_CNPJ_REGISTRATION","POLICY_VIOLATIONS","PREPAY_INSUFFICIENT_BALANCE","PRE_AUTH_FAILURE_SUSPENSION","RO_INSUFFICIENT_BALANCE","SELLER_ACCOUNT_BALANCE_LOW","SELLER_ACCOUNT_BALANCE_RESERVED","SELLER_ACCOUNT_INSUFFICIENT_AVAILABLE_BALANCE_CAUSED_SUSPENSION","SELLER_ACCOUNT_INSUFFICIENT_GROSS_BALANCE_CAUSED_SUSPENSION","SELLER_ACCOUNT_MISSING_BACKUP","SELLER_ACCOUNT_PAYMENT_FAILURE_CAUSED_SUSPENSION","SELLER_ACCOUNT_WITH_CREDIT_CARD_FALLBACK_PAYMENT_FAILURE_CAUSED_SUSPENSION","STORED_VALUE_AUTO_RELOAD_PAYMENT_FAILURE","SUSPICIOUS_ACTIVITY","TAX_ID_VALIDATION_IN_PROGRESS","TAX_ID_VALIDATION_REJECTED"],"type":"string"},"billingNotificationSeverity":{"enum":["ALERT","INFO","WARNING"],"type":"string"},"billingStatus":{"properties":{"billingStatusCode":{"$ref":"#/components/schemas/billingStatusCode"},"message":{"type":"string"}},"required":["billingStatusCode","message"],"type":"object"},"billingStatusCode":{"enum":["ACCOUNT_BILLING_ISSUE","INVALID_PAYMENT_REGISTRATION","PAYMENT_METHOD_EXPIRED","PAYMENT_METHOD_VERIFICATION_FAILED","PENDING_BILLING_REGISTRATION","PENDING_PAYMENT_REGISTRATION","PENDING_TAX_REGISTRATION","RESERVE_ORDER_BALANCE_TOO_LOW","STORED_VALUE_BALANCE_TOO_LOW","VALID_BILLING_STATUS"],"type":"string"},"bulkGetBillingNotificationsError":{"properties":{"advertiserMarketplace":{"$ref":"#/components/schemas/advertiserMarketplace"},"advertiserMarketplaces":{"items":{"$ref":"#/components/schemas/advertiserMarketplace","properties":{}},"maxItems":30,"minItems":1,"type":"array"},"description":{"type":"string"},"errorCode":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorCodes"},"index":{"format":"int32","type":"integer"}},"required":["description","errorCode","index"],"type":"object"},"bulkGetBillingNotificationsErrorCodes":{"enum":["BAD_REQUEST","INTERNAL_ERROR","NOT_AUTHORIZED","NOT_FOUND"],"type":"string"},"bulkGetBillingNotificationsErrorResponse":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"bulkGetBillingNotificationsRequestBody":{"description":"The properties needed to get the billing notifications for a set of advertisers.","properties":{"advertiserMarketplaces":{"items":{"$ref":"#/components/schemas/advertiserMarketplace"},"maxItems":30,"minItems":1,"type":"array"},"locale":{"$ref":"#/components/schemas/locale"}},"type":"object"},"bulkGetBillingNotificationsResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/bulkGetBillingNotificationsError","properties":{}},"maxItems":30,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/bulkGetBillingNotificationsSuccess","properties":{}},"maxItems":30,"minItems":0,"type":"array"}},"required":["error","success"],"type":"object"},"bulkGetBillingNotificationsSuccess":{"properties":{"advertiserMarketplace":{"$ref":"#/components/schemas/advertiserMarketplace"},"billingNotifications":{"items":{"$ref":"#/components/schemas/billingNotification","properties":{}},"maxItems":30,"minItems":0,"type":"array"},"index":{"format":"int32","type":"integer"}},"required":["billingNotifications","index"],"type":"object"},"bulkGetBillingStatusError":{"properties":{"advertiserMarketplace":{"$ref":"#/components/schemas/advertiserMarketplace"},"description":{"type":"string"},"errorCode":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorCodes"},"index":{"format":"int32","type":"integer"}},"required":["advertiserId","index"],"type":"object"},"bulkGetBillingStatusErrorCodes":{"enum":["BAD_REQUEST","INTERNAL_ERROR","NOT_AUTHORIZED","NOT_FOUND"],"type":"string"},"bulkGetBillingStatusErrorResponse":{"properties":{"message":{"type":"string"}},"type":"object"},"bulkGetBillingStatusResponse":{"properties":{"error":{"items":{"$ref":"#/components/schemas/bulkGetBillingStatusError","properties":{}},"maxItems":30,"minItems":0,"type":"array"},"success":{"items":{"$ref":"#/components/schemas/bulkGetBillingStatusSuccess","properties":{}},"maxItems":30,"minItems":0,"type":"array"}},"required":["error","success"],"type":"object"},"bulkGetBillingStatusSuccess":{"properties":{"advertiserMarketplace":{"$ref":"#/components/schemas/advertiserMarketplace"},"billingStatus":{"$ref":"#/components/schemas/billingStatus"},"index":{"format":"int32","type":"integer"}},"required":["advertiserMarketplace","billingStatus","index"],"type":"object"},"bulkGetBillingStatusesRequestBody":{"description":"The properties needed to get the billing statuses for a set of advertisers.","properties":{"advertiserMarketplaces":{"items":{"$ref":"#/components/schemas/advertiserMarketplace"},"maxItems":30,"minItems":1,"type":"array"},"locale":{"$ref":"#/components/schemas/locale"}},"required":["advertiserMarketplaces"],"type":"object"},"contactInfo":{"properties":{"address":{"$ref":"#/components/schemas/address"},"email":{"$ref":"#/components/schemas/email"}},"required":["address","email"],"type":"object"},"countryCode":{"description":"ISO 3611 country code","type":"string"},"currencyAmount":{"properties":{"amount":{"type":"number"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"}},"type":"object"},"currencyCode":{"description":"The currency used for all monetary values for entities under this profile\n|Region|`countryCode`|Country Name|`currencyCode`|\n|-|-|-|-|\n|NA|US|United States|USD|\n|NA|CA|Canada|CAD|\n|NA|MX|Mexico|MXN|\n|...","enum":["AED","AUD","BRL","CAD","EGP","EUR","GBP","INR","JPY","MXN","PLN","SAR","SEK","SGD","TRY","USD"],"type":"string"},"date":{"description":"Date in YYYYMMDD format","type":"string"},"documentType":{"enum":["CREDIT_NOTE","INVOICE"],"type":"string"},"email":{"properties":{"displayName":{"description":"Customer name used in email communication.\n","type":"string"},"emailAddress":{"type":"string"}},"required":["displayName","emailAddress"],"type":"object"},"fee":{"properties":{"cost":{"$ref":"#/components/schemas/currencyAmount"},"feeIdentifiers":{"description":"Identifiers describing attributes for different fee types.\n* countryCode: ISO 3611 country code for country specific Regulatory Advertising Fees.\n","properties":{"countryCode":{"$ref":"#/components/schemas/countryCode","properties":{}}},"type":"object"},"feeType":{"description":"* `PLATFORM_FEE`: Billable fee set at the Rodeo Entity level by internal users which reflects the cost of using the Amazon DSP\n * Supply Cost * Platform Fee %\n* `AGENCY_FEE`: Non-billable fee set at...","enum":["3P_AUTO_NON_ABSORBED_FEE","3P_NON_ABSORBED_FEE","3P_PREBID_FEE","AUDIENCE_FEE","OMNICHANNEL_METRICS_FEE","PLATFORM_FEE","REGULATORY_ADVERTISING_FEE","REWARDED_ADS_COST"],"type":"string"}},"required":["cost","feeType"],"type":"object"},"governmentInvoiceInformation":{"description":"Government invoice data is provided in marketplaces (such as Italy or India) that require a government-assigned invoice ID.","properties":{"countryCode":{"$ref":"#/components/schemas/countryCode"},"governmentDocumentS3Link":{"description":"PreSigned URL to grant time-limited download access for govt invoice pdf","type":"string"},"governmentInvoiceId":{"description":"Government generated ID","type":"string"},"governmentXmlDocumentS3Link":{"description":"PreSigned URL to grant time-limited download access for govt invoice XML","type":"string"},"transactionType":{"enum":["CREDIT","DEBIT"],"type":"string"}},"type":"object"},"invoice":{"properties":{"adjustments":{"$ref":"#/components/schemas/adjustments"},"governmentInvoiceInformation":{"$ref":"#/components/schemas/governmentInvoiceInformation"},"invoiceLines":{"$ref":"#/components/schemas/invoiceLines"},"invoiceSummary":{"$ref":"#/components/schemas/invoiceSummary"},"issuerContactInfo":{"$ref":"#/components/schemas/contactInfo"},"payerContactInfo":{"$ref":"#/components/schemas/contactInfo"},"payments":{"$ref":"#/components/schemas/payments"},"portfolios":{"$ref":"#/components/schemas/portfolios"},"promotions":{"$ref":"#/components/schemas/promotions"},"taxDetail":{"$ref":"#/components/schemas/taxDetail"},"thirdPartyContactInfo":{"$ref":"#/components/schemas/thirdPartyContactInformation"}},"required":["adjustments","invoiceLines","invoiceSummary","issuerContactInfo","payerContactInfo","payments","portfolios","promotions","taxDetail","thirdPartyContactInfo"],"type":"object"},"invoiceLine":{"properties":{"campaignId":{"format":"int64","type":"integer"},"campaignName":{"type":"string"},"campaignTags":{"additionalProperties":{"description":"The key-value pair for the campaign tag.","properties":{},"type":"string"},"description":"Campaign tags in the form of string key-value pairs.","type":"object"},"commissionAmount":{"$ref":"#/components/schemas/currencyAmount"},"commissionRate":{"type":"number"},"cost":{"$ref":"#/components/schemas/currencyAmount"},"costEventCount":{"description":"Number of clicks/impressions charged","format":"int64","type":"integer"},"costEventType":{"description":"Type of event charged (clicks or impressions)","enum":["CLICKS","IMPRESSIONS"],"type":"string"},"costPerEventType":{"description":"Ad spends cost (Cost exclusive of adjustments/promotions/fees/etc) per unit (thousand impressions/clicks).\n","type":"number"},"costPerUnit":{"type":"number"},"fees":{"description":"Charges can include different fees (see feeType below).\n","items":{"$ref":"#/components/schemas/fee","properties":{}},"type":"array"},"name":{"type":"string"},"portfolioId":{"description":"Sponsored Ads only. This identifier maps to one of the portfolios listed in the portfolios section.\n","format":"int64","type":"integer"},"priceType":{"description":"Metric used for performance measurement.","enum":["CPC","CPM"],"type":"string"},"programName":{"$ref":"#/components/schemas/adProgram"},"promotionAmount":{"$ref":"#/components/schemas/currencyAmount"},"purchaseOrderNumber":{"type":"string"},"supplyCost":{"$ref":"#/components/schemas/currencyAmount"}},"required":["cost","costEventCount","costEventType","costPerUnit","name","priceType"],"type":"object"},"invoiceLines":{"description":"Line items for this invoice. For Sponsored Ads, this will be a per-campaign breakdown of charges. For DSP, this will be the line items for the campaign getting invoiced.","items":{"$ref":"#/components/schemas/invoiceLine"},"type":"array"},"invoiceStatus":{"description":"* `ISSUED`: An invoice is issued when its charges are finalized and tax is computed on the total amount.","enum":["ACCUMULATING","ISSUED","PAID_IN_FULL","PAID_IN_PART","PROCESSING","WRITTEN_OFF"],"type":"string"},"invoiceSummary":{"properties":{"amountDue":{"$ref":"#/components/schemas/currencyAmount"},"billingAggregation":{"$ref":"#/components/schemas/billingAggregation"},"downloadableDocuments":{"description":"List of downloadable documents associated with this invoice and accessible from the advertising console.\n","items":{"$ref":"#/components/schemas/documentType","properties":{}},"type":"array"},"dueDate":{"$ref":"#/components/schemas/date"},"fees":{"description":"Regulatory Advertising Fees.\n","items":{"$ref":"#/components/schemas/fee","properties":{}},"type":"array"},"fromDate":{"$ref":"#/components/schemas/date"},"id":{"type":"string"},"invoiceDate":{"$ref":"#/components/schemas/date"},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"paymentTermsDays":{"type":"integer"},"paymentTermsType":{"enum":["EOM","NET"],"type":"string"},"purchaseOrderNumber":{"type":"string"},"remainingAmountDue":{"$ref":"#/components/schemas/currencyAmount"},"remainingFees":{"description":"Remaining Regulatory Advertising Fees.\n","items":{"$ref":"#/components/schemas/fee","properties":{}},"type":"array"},"remainingTaxAmountDue":{"$ref":"#/components/schemas/currencyAmount"},"status":{"$ref":"#/components/schemas/invoiceStatus"},"taxAmountDue":{"$ref":"#/components/schemas/currencyAmount"},"taxRate":{"type":"number"},"toDate":{"$ref":"#/components/schemas/date"}},"required":["amountDue","fromDate","id","invoiceDate","remainingAmountDue","status","toDate"],"type":"object"},"locale":{"enum":["ar_AE","bn_IN","cs_CZ","de_DE","en_AE","en_AU","en_CA","en_GB","en_IN","en_NG","en_SG","en_US","en_ZA","es_CL","es_CO","es_ES","es_MX","es_US","fr_BE","fr_CA","fr_FR","he_IL","hi_IN","it_IT","ja_JP","ko_KR","ml_IN","mr_IN","nl_BE","nl_NL","pl_PL","pt_BR","pt_PT","sv_SE","ta_IN","te_IN","tr_TR","zh_CN","zh_TW"],"type":"string"},"payment":{"properties":{"amount":{"$ref":"#/components/schemas/currencyAmount"},"currentPaymentAttemptDate":{"$ref":"#/components/schemas/date"},"id":{"format":"int64","type":"integer"},"lastPaymentAttemptDate":{"$ref":"#/components/schemas/date"},"nextPaymentAttemptDate":{"$ref":"#/components/schemas/date"},"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"reason":{"description":"Provides additional details and reason for the payment status","type":"string"},"refundedAmount":{"$ref":"#/components/schemas/currencyAmount"},"status":{"enum":["FAILED","PROCESSING","REFUNDED","SUCCEEDED","VERIFICATION_REQUIRED","VOIDED"],"type":"string"}},"required":["amount","id","paymentMethod","status"],"type":"object"},"paymentMethod":{"enum":["CREDIT_CARD","DEDUCT_FROM_PAYMENT","DIRECT_DEBIT","ELECTRONIC_FUNDS_TRANSFER","PREPAY","UNIFIED_BILLING"],"type":"string"},"payments":{"description":"List of payments made against the invoice.","items":{"$ref":"#/components/schemas/payment"},"type":"array"},"portfolio":{"properties":{"feeAmount":{"$ref":"#/components/schemas/currencyAmount"},"id":{"type":"integer"},"name":{"type":"string"},"totalAmount":{"$ref":"#/components/schemas/currencyAmount"}},"required":["id","name","totalAmount"],"type":"object"},"portfolios":{"description":"Sponsored Ads only. This is a list of portfolios with their name, ID and the total cost of the campaign(s) they contain. This totalAmount corresponds to the sum of the invoice lines tagged with the ID of this portfolio.\n","items":{"$ref":"#/components/schemas/portfolio"},"type":"array"},"promotion":{"properties":{"amount":{"$ref":"#/components/schemas/currencyAmount"},"description":{"type":"string"},"lastConsumedDate":{"$ref":"#/components/schemas/date"}},"required":["amount","description","lastConsumedDate"],"type":"object"},"promotions":{"description":"List of promotions applied to the charges in this invoice.","items":{"$ref":"#/components/schemas/promotion"},"type":"array"},"taxBreakup":{"properties":{"issuerJurisdiction":{"description":"Tax jurisdiction of issuer (Amazon billing entity)\n","type":"string"},"issuerTaxInformation":{"properties":{"taxId":{"description":"Tax registration with government (Ex: VAT ID, GST ID)\n","properties":{},"type":"string"}},"required":["taxId"],"type":"object"},"payerJurisdiction":{"description":"Tax jurisdiction of payer (billed customer)\n","type":"string"},"payerTaxInformation":{"properties":{"taxId":{"description":"Tax registration with government (Ex: VAT ID, GST ID)\n","properties":{},"type":"string"}},"type":"object"},"taxAmount":{"$ref":"#/components/schemas/currencyAmount"},"taxName":{"type":"string"},"taxRate":{"type":"number"},"taxedJurisdictionName":{"description":"Tax jurisdiction for which tax applies, this can be at the country, state or local level.\n","type":"string"},"thirdPartyTaxInformation":{"properties":{"taxId":{"description":"Tax registration with government (Ex: VAT ID, GST ID)\n","properties":{},"type":"string"}},"required":["taxId"],"type":"object"}},"required":["issuerJurisdiction","issuerTaxInformation","payerTaxInformation","taxAmount","taxName","taxRate","taxedJurisdictionName"],"type":"object"},"taxDetail":{"properties":{"permanentAccountNumber":{"description":"**IN only** field that represents the tax account number of the billed entity entered on AMS portal.\n","type":"string"},"taxBreakups":{"description":"List of taxes applied on the transaction for this invoice.","items":{"$ref":"#/components/schemas/taxBreakup","properties":{}},"type":"array"},"taxCalculationDate":{"$ref":"#/components/schemas/date"}},"required":["taxBreakups","taxCalculationDate"],"type":"object"},"thirdPartyContactInformation":{"description":"Additional contacts. This field is used in cases such as Loi Sapin in France where both advertiser and agency addresses need to be provided.\n","items":{"$ref":"#/components/schemas/contactInfo"},"type":"array"}},"securitySchemes":{}},"info":{"title":"Advertising Billing","version":"3.0"},"openapi":"3.0.1","paths":{"/billing/documents/{documentId}":{"get":{"description":"Gets billing document(s) with id.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissio...","operationId":"GetDocument","parameters":[{"in":"path","name":"documentId","required":true,"schema":{"type":"string"}},{"explode":true,"in":"query","name":"docType","required":true,"schema":{"items":{"$ref":"#/components/schemas/DocType"},"maxItems":6,"minItems":1,"type":"array"},"style":"form"},{"description":"Account identifier","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"description":"The header used to pass the ID of a manager account. Use `GET` method on the Manager Accounts resource to list the manager accounts associated with the access token passed in the HTTP Authorization header and choose `managerAccountId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Manager-Account","schema":{"description":"The header used to pass the ID of a manager account. Use `GET` method on the Manager Accounts resource to list the manager accounts associated with the access token passed in the HTTP Authorization header and choose `managerAccountId` from the response to pass it as input.","minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/vnd.billingDocuments.v1+json":{"schema":{"$ref":"#/components/schemas/GetDocumentResponseContent"}}},"description":"GetDocument 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionResponseContent"}}},"description":"ValidationException 400 response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedExceptionResponseContent"}}},"description":"UnauthorizedException 401 response"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundExceptionResponseContent"}}},"description":"ResourceNotFoundException 404 response"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerExceptionResponseContent"}}},"description":"InternalServerException 500 response"}},"tags":["Billing Documents"]}},"/billing/invoices/pay":{"post":{"description":"Executes payment on a set of or all of an advertisers open invoices.\n\n**Requires one of these permissions**:\n[\"adv_billing_edit\"]","operationId":"PayInvoices","parameters":[{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsProfileHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsPayInvoicesInput"}}},"description":"This API executes payment on one or multiple open invoices.","required":true},"responses":{"207":{"content":{"application/vnd.invoices.v1+json":{"schema":{"$ref":"#/components/schemas/AdPaymentsPayInvoicesOutput"}}},"description":"Successful response of the operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to invalid client input."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to reaching the rate limit."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Pay Invoices"]}},"/billing/notifications":{"post":{"description":"Gets an array of all currently valid billing notifications associated for each advertising account.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-Acco...","operationId":"bulkGetBillingNotifications","parameters":[{"$ref":"#/components/parameters/AdPaymentsAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsManagerAccountIdHeader"}],"requestBody":{"content":{"application/vnd.billingnotifications.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.bulkgetbillingnotificationsresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsResponse"}}},"description":"Successful Request"},"400":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Forbidden - Request failed because user does not have access to a specified resource,"},"404":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Not Found - Requested account was not found."},"429":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.bulkgetbillingnotificationserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingNotificationsErrorResponse"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Get the billing notifications for a list advertising accounts.","tags":["Billing Notifications"]}},"/billing/paymentAgreements":{"post":{"description":"Creates or updates payment agreements.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these perm...","operationId":"CreatePaymentAgreements","parameters":[{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsProfileHeader"},{"$ref":"#/components/parameters/AdPaymentsManagerAccountIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsCreatePaymentAgreementsInput"}}},"description":"This API creates or updates payment agreements.","required":true},"responses":{"207":{"content":{"application/vnd.paymentagreements.v1+json":{"schema":{"$ref":"#/components/schemas/AdPaymentsCreatePaymentAgreementsOutput"}}},"description":"Successful response of the operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to invalid client input."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to reaching the rate limit."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Create Payment Agreement"]}},"/billing/paymentAgreements/list":{"post":{"description":"Gets current payment agreement for a customer.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of th...","operationId":"GetPaymentAgreements","parameters":[{"$ref":"#/components/parameters/AdPaymentsAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsProfileHeader"},{"$ref":"#/components/parameters/AdPaymentsManagerAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsNextTokenQueryParam"},{"description":"The type of payment agreement to query for.","in":"query","name":"agreementType","required":true,"schema":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementType"}}],"responses":{"200":{"content":{"application/vnd.paymentagreements.v1+json":{"schema":{"$ref":"#/components/schemas/AdPaymentsGetPaymentAgreementOutput"}}},"description":"Successful response of the operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to invalid client input."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to reaching the rate limit."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Get Payment Agreements"]}},"/billing/paymentMethods/list":{"post":{"description":"Retrieves eligible payment methods for a customer.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one o...","operationId":"GetCustomerPaymentMethods","parameters":[{"$ref":"#/components/parameters/AdPaymentsAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsProfileHeader"},{"$ref":"#/components/parameters/AdPaymentsManagerAccountIdHeader"},{"$ref":"#/components/parameters/AdPaymentsNextTokenQueryParam"},{"description":"Criteria Types to that can be used to filter the payment methods in the GET Payment methods API.","in":"query","name":"criteriaType","required":true,"schema":{"$ref":"#/components/schemas/AdPaymentsPaymentAgreementType"}}],"responses":{"200":{"content":{"application/vnd.paymentmethods.v1+json":{"schema":{"$ref":"#/components/schemas/AdPaymentsGetCustomerPaymentMethodsOutput"}}},"description":"Successful response of the operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to invalid client input."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to reaching the rate limit."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Get Payment Methods"]}},"/billing/paymentProfiles":{"post":{"description":"Creates or updates payment profiles.\n\n**Authorized resource type**:\nGlobal Ad Account ID, Profile ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permis...","operationId":"CreatePaymentProfiles","parameters":[{"description":"The identifier of a profile associated with the advertiser account.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AdPaymentsClientHeader"},{"$ref":"#/components/parameters/AdPaymentsManagerAccountIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsCreatePaymentProfileInput"}}},"description":"This API creates or updates payment profiles.","required":true},"responses":{"207":{"content":{"application/vnd.paymentprofiles.v1+json":{"schema":{"$ref":"#/components/schemas/AdPaymentsCreatePaymentProfilesOutput"}}},"description":"Successful response of the operation."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to invalid client input."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"The operation failed due to reaching the rate limit."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdPaymentsError"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."}},"tags":["Create Payment Profiles"]}},"/billing/statuses":{"post":{"description":"Gets the current billing status associated for each advertising account.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"adv_billing_view\",\"adv_billing_edit\"]","operationId":"bulkGetBillingStatus","requestBody":{"content":{"application/vnd.bulkgetbillingstatusrequestbody.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusesRequestBody"}}},"required":true},"responses":{"200":{"content":{"application/vnd.bulkgetbillingstatusresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusResponse"}}},"description":"Successful"},"400":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Forbidden - Request failed because user does not have access to a specified resource,"},"404":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Not Found - Requested account was not found."},"429":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.bulkgetbillingstatuserrorresponse.v1+json":{"schema":{"$ref":"#/components/schemas/bulkGetBillingStatusErrorResponse"}}},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Get the billing status for a list of advertising accounts.","tags":["Billing Status"]}},"/billingProfileAgreementContents/{billingProfileAgreementContentId}":{"get":{"description":"User needs to provide consent to certain agreements before creating a billing profile. This API provides a way for users to go through the agreement content.","operationId":"GetBillingProfileAgreementContent","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}},{"description":"agreementId for which the content needs to be fetched. This is same as the `documentName` in create/update billing profiles request","in":"path","name":"billingProfileAgreementContentId","required":true,"schema":{"type":"string"}},{"description":"This selection controls the language of preference (or `locale`) and the returned values of agreement content to match that language.","in":"query","name":"languageOfPreference","required":false,"schema":{"default":"en_US","type":"string"}}],"responses":{"200":{"content":{"application/vnd.billingProfileAgreement.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileAgreementContentResponse"}}},"description":"Get opertation was successful. `content` contains the HTML content of the agreement requested"},"401":{"content":{"application/vnd.billingProfileAgreement.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile agreement couldn't be fetched because of unauthenticated access."},"403":{"content":{"application/vnd.billingProfileAgreement.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile agreement couldn't be fetched because of unauthorized access."},"404":{"content":{"application/vnd.billingProfileAgreement.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile agreement couldn't be fetched because content doesn't exist."},"500":{"content":{"application/vnd.billingProfileAgreement.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile agreement couldn't be fetched because of internal error."}},"summary":"API to fetch agreement contents related to billing profiles.","tags":["Billing Profiles"]}},"/billingProfileUsages":{"post":{"description":"API to link one or more countries with a billing profile. The linked BillingProfile's billing informationwill be used for invoicing, taxes and other billing workflows.","operationId":"ApplyBillingProfile","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/ApplyBillingProfileRequest"}}},"description":"The request body accepts a list of billing profile identifiers and advertisers for association.","required":true},"responses":{"207":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/ApplyBillingProfileResponse"}}},"description":"Some Billing profile(s) may have been applied. Response may contain partial success. More details on the successful/failed applications will be present in the response body"},"400":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be applied because of invalid request payload."},"401":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be applied because of unauthenticated access."},"500":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be applied because of internal error."}},"summary":"API to link one or more countries with a billing profile. This association is known as 'applying' a billing profile.","tags":["Billing Profiles"]}},"/billingProfileUsages/list":{"post":{"description":"Lists the billing profiles linked to each country of global ads account. You can further narrow down the search by providing the countries you want the billing profiles for.","operationId":"GetBillingProfileUsages","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/GetBillingProfileUsageRequest"}}},"description":"The request body to fetch billing profiles linked to each country of global ads account.","required":true},"responses":{"200":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/GetBillingProfileUsageResponse"}}},"description":"Linked billing profile(s) are successfully fetched."},"400":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of invalid request payload."},"401":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of unauthenticated access"},"500":{"content":{"application/vnd.billingProfileUsage.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of internal error"}},"summary":"Lists the billing profiles linked to each country of global ads account.","tags":["Billing Profiles"]}},"/billingProfiles":{"post":{"description":"Creates one or more billing profiles. A Billing Profile contains billing information (address, taxes, agreements etc..) that will be used for invoicing and other billing workflows.","operationId":"CreateBillingProfiles","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingProfilesRequest"}}},"description":"The request body accepts a list of billing profiles to be created in batch.","required":true},"responses":{"207":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateBillingProfilesResponse"}}},"description":"Updates one or more billing profiles under a global or manager account which can then be applied in Sponsored Products/Brands/Display segments."},"400":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be created because of invalid request payload."},"401":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be created because of unauthenticated access."},"500":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be created because of internal error."}},"summary":"API to create one or more billing profile(s).","tags":["Billing Profiles"]},"put":{"description":"Updates one or more billing profiles under a global account Please note that `isBillTo` and `type` are immutable attributes and cannot be updated -- in this case, user can always create a new billing...","operationId":"UpdateBillingProfiles","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingProfilesRequest"}}},"description":"The request body accepts a list of billing profiles to be updated in batch.","required":true},"responses":{"207":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateBillingProfilesResponse"}}},"description":"Billing profile(s) is(are) updated. Response may contain partial success."},"400":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be updated because of invalid request payload."},"401":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be updated because of unauthenticated access."},"500":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be updated because of internal error."}},"summary":"API to update one or more billing profile(s).","tags":["Billing Profiles"]}},"/billingProfiles/list":{"post":{"description":"Fetches billing profiles present under the global account. You can limit the search results by providing filters like `defaultBillingProfileFilter` and `billingProfileIdFilter` in which case only resu...","operationId":"GetBillingProfiles","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/GetBillingProfilesRequest"}}},"description":"The request body to fetch one or more billing profile(s).","required":true},"responses":{"200":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/GetBillingProfilesResponse"}}},"description":"Billing profile(s) is(are) fetched."},"400":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be fetched because of invalid request payload."},"401":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be fetched because of unauthenticated access."},"500":{"content":{"application/vnd.billingProfile.v1+json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Billing profile(s) couldn't be fetched because of internal error."}},"summary":"Fetches billing profiles present under the global account. ","tags":["Billing Profiles"]}},"/billingStatements":{"post":{"description":"Request to create billing statement for advertiser advertising in Sponsored Products/Brands/Display segment.","operationId":"CreateBillingStatement","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Used for authentication of Global Account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/CreateBillingStatementRequest"}}},"description":"The request body accepts filters required for generation of the billing statement report.","required":true},"responses":{"202":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/CreateBillingStatementResponse"}}},"description":"Billing statement creation request accepted and request identifier is generated."},"400":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"Bad Request, caused due to invalid argument passed in the request."},"401":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"**Unauthorized** - The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"**Forbidden** - The request failed because the caller is not authorized to the requested account."},"404":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"Account doesn't exists for which billing statement is requested."},"500":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"Internal server error, caused due to some internal error."}},"summary":"API to request billing statement generation for an Advertising account.","tags":["Billing Statements"]}},"/billingStatements/{billingStatementRequestId}":{"get":{"description":"API to fetch the latest status of Billing Statements creation request and billing statement download link if available.","operationId":"GetBillingStatement","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"Billing Statement Request Id.","in":"path","name":"billingStatementRequestId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/GetBillingStatementResponse"}}},"description":"Successful Operation."},"401":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"**Unauthorized** - The request failed because the user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"**Forbidden** - The request failed because the caller is not authorized to the requested account."},"404":{"content":{"application/vnd.createbillingstatementsrequest.v1+json":{"schema":{"$ref":"#/components/schemas/BillingStatementErrorResponse"}}},"description":"Billing Statement not found for the given billingStatementRequestId."}},"summary":"API to fetch the latest status of Billing Statements creation request and billing statement download link if available.","tags":["Billing Statements"]}},"/invoiceSummaries/list":{"post":{"description":"Lists the billing invoice summary(s) in a global ads account. You can further narrow down the search by providing filter(s) over country, status, paymentMethod with 'exact' and 'broad' match, search o...","operationId":"GetBillingInvoiceSummaries","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of an account. Account can be a global advertising account.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Advertising-API-Manager-Account","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.billingInvoiceSummary.v1+json":{"schema":{"$ref":"#/components/schemas/BillingInvoiceSummariesRequest"}}},"description":"Payload with filter, sort and aggregate key(s) to fetch list of billing invoice summary(s).","required":true},"responses":{"200":{"content":{"application/vnd.billingInvoiceSummary.v1+json":{"schema":{"$ref":"#/components/schemas/BillingInvoiceSummariesResponse"}}},"description":"Contains an object encapsulating either the aggregation result(s) or sorted & filtered billing invoice summary(s)."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of invalid request payload."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of unauthenticated access"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingProfileErrorResponse"}}},"description":"Operation failed because of internal error"}},"summary":"Lists the billing invoice summary(s) in a global ads account as per the search and aggregation parameters passed in the request","tags":["Billing Invoice Summary(s)"]}},"/invoices":{"get":{"description":"\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\",\"nemo_transactions_edit\"]","operationId":"getAdvertiserInvoices","parameters":[{"description":"* `ISSUED`: An invoice is issued when its charges are finalized and tax is computed on the total amount.","explode":false,"in":"query","name":"invoiceStatuses","schema":{"items":{"enum":["ISSUED","PAID_IN_FULL","PAID_IN_PART","WRITTEN_OFF"],"type":"string"},"type":"array"},"style":"form"},{"description":"The starting date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","in":"query","name":"startDate","schema":{}},{"description":"The ending date (inclusive) of the date range for filtering invoices. Please provide the date in ISO-8601 format, representing a UTC date with only the date portion (no time).","in":"query","name":"endDate","schema":{}},{"description":"Number of records to include in the paged response. Defaults to 100. Cannot be combined with the cursor parameter.","in":"query","name":"count","schema":{"maximum":100,"minimum":0,"type":"integer"}},{"description":"A cursor representing how far into a result set this query should begin. In the absence of a cursor the request will default to start index of 0 and page size of 100.","in":"query","name":"cursor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.invoices.v1.1+json":{"schema":{"properties":{"invoiceSummaries":{"items":{"$ref":"#/components/schemas/invoiceSummary"},"type":"array"},"nextCursor":{"description":"This will be null when at the end of your result set. This will be present even if the original query had a startIndex and count","type":"string"},"previousCursor":{"description":"Optional parameter that links to the previous data set if relevant","type":"string"}},"type":"object"}}},"description":"successful operation"},"400":{"content":{},"description":"Bad Request"},"401":{"content":{},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{},"description":"Forbidden - Request failed because user does not have access to a specified resource,"},"404":{"content":{},"description":"Not Found - Requested account was not found."},"429":{"content":{},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Get invoices for advertiser","tags":["invoice"]}},"/invoices/{invoiceId}":{"get":{"description":"\n\n**Requires one of these permissions**:\n[\"nemo_transactions_view\",\"nemo_transactions_edit\"]","operationId":"getInvoice","parameters":[{"description":"ID of invoice to fetch","in":"path","name":"invoiceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.invoice.v1.1+json":{"schema":{"$ref":"#/components/schemas/invoice"}}},"description":"Successful Operation"},"400":{"content":{},"description":"Bad Request"},"401":{"content":{},"description":"Unauthorized - Request failed because user is not authenticated or is not allowed to invoke the operation."},"403":{"content":{},"description":"Forbidden - Request failed because user does not have access to a specified resource,"},"404":{"content":{},"description":"Not Found - Requested invoice was not found."},"429":{"content":{},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{},"description":"Internal Server Error - Something went wrong on the server. Retry later and report an error if unresolved."}},"summary":"Get invoice data by invoice ID","tags":["invoice"]}}}}