Skip to main content
POST
/
merchant
/
invoice
/
credit_note
/
list
Bulk CreditNote(Refund Invoice) Invoice List
curl --request POST \
  --url https://api.unibee.dev/merchant/invoice/credit_note/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "count": 123,
  "createTimeEnd": 123,
  "createTimeStart": 123,
  "currency": "<string>",
  "emails": "<string>",
  "gatewayIds": [
    123
  ],
  "page": 123,
  "planIds": [
    123
  ],
  "searchKey": "<string>",
  "sortField": "<string>",
  "sortType": "<string>",
  "status": [
    123
  ]
}'
{
  "code": 123,
  "data": {
    "creditNotes": [
      {
        "bizType": 123,
        "countryCode": "<string>",
        "createFrom": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "discount": {
          "advance": true,
          "billingType": 123,
          "code": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "cycleLimit": 123,
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountType": 123,
          "endTime": 123,
          "id": 123,
          "isDeleted": 123,
          "merchantId": 123,
          "metadata": {},
          "name": "<string>",
          "planApplyGroup": {
            "currency": [
              "<string>"
            ],
            "groupPlanIntervalSelector": [
              {}
            ],
            "type": [
              123
            ]
          },
          "planApplyType": 123,
          "planIds": [
            123
          ],
          "quantity": 123,
          "startTime": 123,
          "status": 123,
          "upgradeLongerOnly": true,
          "upgradeOnly": true,
          "userLimit": 123,
          "userScope": 123
        },
        "discountAmount": 123,
        "discountCode": "<string>",
        "finishTime": 123,
        "gateway": {
          "IsSetupFinished": true,
          "archive": true,
          "autoChargeEnabled": true,
          "bank": {
            "ABARoutingNumber": "<string>",
            "CNAPS": "<string>",
            "Remarks": "<string>",
            "accountHolder": "<string>",
            "accountNumber": "<string>",
            "address": "<string>",
            "bankName": "<string>",
            "bic": "<string>",
            "bsbCode": "<string>",
            "iban": "<string>",
            "swiftCode": "<string>"
          },
          "companyIssuer": {
            "issueAddress": "<string>",
            "issueCompanyName": "<string>",
            "issueLogo": "<string>",
            "issueRegNumber": "<string>",
            "issueVatNumber": "<string>"
          },
          "countryConfig": {},
          "createTime": 123,
          "currency": "<string>",
          "currencyExchange": [
            {
              "exchange_rate": 123,
              "from_currency": "<string>",
              "to_currency": "<string>"
            }
          ],
          "currencyExchangeEnabled": true,
          "defaultGatewayPaymentType": {
            "autoCharge": true,
            "category": "<string>",
            "countryName": "<string>",
            "name": "<string>",
            "paymentType": "<string>",
            "supportCurrencies": [
              "<string>"
            ]
          },
          "description": "<string>",
          "displayName": "<string>",
          "gatewayIcons": [
            "<string>"
          ],
          "gatewayId": 123,
          "gatewayKey": "<string>",
          "gatewayLogo": "<string>",
          "gatewayName": "<string>",
          "gatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>",
              "supportCurrencies": [
                "<string>"
              ]
            }
          ],
          "gatewaySecret": "<string>",
          "gatewayType": 123,
          "gatewayWebhookIntegrationLink": "<string>",
          "gatewayWebsiteLink": "<string>",
          "isDefault": true,
          "metadata": {},
          "minimumAmount": 123,
          "name": "<string>",
          "privateSecretName": "<string>",
          "publicKeyName": "<string>",
          "setupGatewayPaymentTypes": [
            {
              "autoCharge": true,
              "category": "<string>",
              "countryName": "<string>",
              "name": "<string>",
              "paymentType": "<string>",
              "supportCurrencies": [
                "<string>"
              ]
            }
          ],
          "sort": 123,
          "subGateway": "<string>",
          "subGatewayName": "<string>",
          "webhookEndpointUrl": "<string>",
          "webhookSecret": "<string>"
        },
        "gatewayId": 123,
        "id": 123,
        "invoiceId": "<string>",
        "invoiceName": "<string>",
        "lines": [
          {
            "amount": 123,
            "amountExcludingTax": 123,
            "currency": "<string>",
            "description": "<string>",
            "discountAmount": 123,
            "fromAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "lineId": "<string>",
            "metricCharge": {
              "CurrentUsedValue": 123,
              "chargePricing": {
                "chargeType": "<any>",
                "graduatedAmounts": "<any>",
                "metricId": "<any>",
                "standardAmount": "<any>",
                "standardStartValue": "<any>"
              },
              "description": "<string>",
              "lines": [
                "<any>"
              ],
              "maxEventId": 123,
              "metricId": 123,
              "minEventId": 123,
              "name": "<string>",
              "totalChargeAmount": 123
            },
            "name": "<string>",
            "originAmount": 123,
            "originUnitAmountExcludeTax": 123,
            "pdfDescription": "<string>",
            "periodEnd": 123,
            "periodStart": 123,
            "plan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                "<any>"
              ],
              "metricMeteredCharge": [
                "<any>"
              ],
              "metricRecurringCharge": [
                "<any>"
              ],
              "multiCurrencies": [
                "<any>"
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123,
              "usVATConfig": {
                "active": "<any>",
                "fromAddress": "<any>",
                "nexusAddresses": "<any>",
                "sellOnUSOnly": "<any>",
                "taxCode": "<any>",
                "toAddress": "<any>"
              }
            },
            "promoCreditDiscountAmount": 123,
            "proration": true,
            "quantity": 123,
            "tax": 123,
            "taxCode": "<string>",
            "taxPercentage": 123,
            "toAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "unitAmountExcludingTax": 123
          }
        ],
        "link": "<string>",
        "merchantId": 123,
        "message": "<string>",
        "metadata": {},
        "originAmount": 123,
        "originalPaymentInvoice": {
          "PaymentMethodId": "<string>",
          "autoCharge": true,
          "billingCycleAnchor": 123,
          "bizType": 123,
          "countryCode": "<string>",
          "createFrom": "<string>",
          "creditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "creditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "cryptoAmount": 123,
          "cryptoCurrency": "<string>",
          "currency": "<string>",
          "data": "<string>",
          "dayUtilDue": 123,
          "discount": {
            "advance": true,
            "billingType": 123,
            "code": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "cycleLimit": 123,
            "discountAmount": 123,
            "discountPercentage": 123,
            "discountType": 123,
            "endTime": 123,
            "id": 123,
            "isDeleted": 123,
            "merchantId": 123,
            "metadata": {},
            "name": "<string>",
            "planApplyGroup": {
              "currency": [
                "<string>"
              ],
              "groupPlanIntervalSelector": [
                {}
              ],
              "type": [
                123
              ]
            },
            "planApplyType": 123,
            "planIds": [
              123
            ],
            "quantity": 123,
            "startTime": 123,
            "status": 123,
            "upgradeLongerOnly": true,
            "upgradeOnly": true,
            "userLimit": 123,
            "userScope": 123
          },
          "discountAmount": 123,
          "discountCode": "<string>",
          "finishTime": 123,
          "gatewayId": 123,
          "id": 123,
          "invoiceId": "<string>",
          "invoiceName": "<string>",
          "lines": [
            {
              "amount": 123,
              "amountExcludingTax": 123,
              "currency": "<string>",
              "description": "<string>",
              "discountAmount": 123,
              "fromAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              },
              "lineId": "<string>",
              "metricCharge": {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": "<any>",
                  "graduatedAmounts": "<any>",
                  "metricId": "<any>",
                  "standardAmount": "<any>",
                  "standardStartValue": "<any>"
                },
                "description": "<string>",
                "lines": [
                  "<any>"
                ],
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              },
              "name": "<string>",
              "originAmount": 123,
              "originUnitAmountExcludeTax": 123,
              "pdfDescription": "<string>",
              "periodEnd": 123,
              "periodStart": 123,
              "plan": {
                "amount": 123,
                "bindingAddonIds": "<string>",
                "bindingOnetimeAddonIds": "<string>",
                "cancelAtTrialEnd": 123,
                "checkoutUrl": "<string>",
                "createTime": 123,
                "currency": "<string>",
                "description": "<string>",
                "disableAutoCharge": 123,
                "externalPlanId": "<string>",
                "extraMetricData": "<string>",
                "gasPayer": "<string>",
                "homeUrl": "<string>",
                "id": 123,
                "imageUrl": "<string>",
                "internalName": "<string>",
                "intervalCount": 123,
                "intervalUnit": "<string>",
                "merchantId": 123,
                "metadata": {},
                "metricLimits": [
                  "<any>"
                ],
                "metricMeteredCharge": [
                  "<any>"
                ],
                "metricRecurringCharge": [
                  "<any>"
                ],
                "multiCurrencies": [
                  "<any>"
                ],
                "planName": "<string>",
                "productId": 123,
                "publishStatus": 123,
                "status": 123,
                "taxPercentage": 123,
                "trialAmount": 123,
                "trialDemand": "<string>",
                "trialDurationTime": 123,
                "type": 123,
                "usVATConfig": {
                  "active": "<any>",
                  "fromAddress": "<any>",
                  "nexusAddresses": "<any>",
                  "sellOnUSOnly": "<any>",
                  "taxCode": "<any>",
                  "toAddress": "<any>"
                }
              },
              "promoCreditDiscountAmount": 123,
              "proration": true,
              "quantity": 123,
              "tax": 123,
              "taxCode": "<string>",
              "taxPercentage": 123,
              "toAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              },
              "unitAmountExcludingTax": 123
            }
          ],
          "link": "<string>",
          "metadata": {},
          "originAmount": 123,
          "partialCreditPaidAmount": 123,
          "paymentId": "<string>",
          "paymentLink": "<string>",
          "paymentType": "<string>",
          "periodEnd": 123,
          "periodStart": 123,
          "planSnapshot": {
            "addons": [
              {
                "addonPlan": {
                  "amount": "<any>",
                  "bindingAddonIds": "<any>",
                  "bindingOnetimeAddonIds": "<any>",
                  "cancelAtTrialEnd": "<any>",
                  "checkoutUrl": "<any>",
                  "createTime": "<any>",
                  "currency": "<any>",
                  "description": "<any>",
                  "disableAutoCharge": "<any>",
                  "externalPlanId": "<any>",
                  "extraMetricData": "<any>",
                  "gasPayer": "<any>",
                  "homeUrl": "<any>",
                  "id": "<any>",
                  "imageUrl": "<any>",
                  "internalName": "<any>",
                  "intervalCount": "<any>",
                  "intervalUnit": "<any>",
                  "merchantId": "<any>",
                  "metadata": "<any>",
                  "metricLimits": "<any>",
                  "metricMeteredCharge": "<any>",
                  "metricRecurringCharge": "<any>",
                  "multiCurrencies": "<any>",
                  "planName": "<any>",
                  "productId": "<any>",
                  "publishStatus": "<any>",
                  "status": "<any>",
                  "taxPercentage": "<any>",
                  "trialAmount": "<any>",
                  "trialDemand": "<any>",
                  "trialDurationTime": "<any>",
                  "type": "<any>",
                  "usVATConfig": "<any>"
                },
                "quantity": 123
              }
            ],
            "autoCharge": true,
            "chargeType": 123,
            "plan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                "<any>"
              ],
              "metricMeteredCharge": [
                "<any>"
              ],
              "metricRecurringCharge": [
                "<any>"
              ],
              "multiCurrencies": [
                "<any>"
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123,
              "usVATConfig": {}
            },
            "previousAddons": [
              {
                "addonPlan": {
                  "amount": "<any>",
                  "bindingAddonIds": "<any>",
                  "bindingOnetimeAddonIds": "<any>",
                  "cancelAtTrialEnd": "<any>",
                  "checkoutUrl": "<any>",
                  "createTime": "<any>",
                  "currency": "<any>",
                  "description": "<any>",
                  "disableAutoCharge": "<any>",
                  "externalPlanId": "<any>",
                  "extraMetricData": "<any>",
                  "gasPayer": "<any>",
                  "homeUrl": "<any>",
                  "id": "<any>",
                  "imageUrl": "<any>",
                  "internalName": "<any>",
                  "intervalCount": "<any>",
                  "intervalUnit": "<any>",
                  "merchantId": "<any>",
                  "metadata": "<any>",
                  "metricLimits": "<any>",
                  "metricMeteredCharge": "<any>",
                  "metricRecurringCharge": "<any>",
                  "multiCurrencies": "<any>",
                  "planName": "<any>",
                  "productId": "<any>",
                  "publishStatus": "<any>",
                  "status": "<any>",
                  "taxPercentage": "<any>",
                  "trialAmount": "<any>",
                  "trialDemand": "<any>",
                  "trialDurationTime": "<any>",
                  "type": "<any>",
                  "usVATConfig": "<any>"
                },
                "quantity": 123
              }
            ],
            "previousPlan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                "<any>"
              ],
              "metricMeteredCharge": [
                "<any>"
              ],
              "metricRecurringCharge": [
                "<any>"
              ],
              "multiCurrencies": [
                "<any>"
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123,
              "usVATConfig": {}
            }
          },
          "productName": "<string>",
          "promoCreditAccount": {
            "amount": 123,
            "createTime": 123,
            "currency": "<string>",
            "currencyAmount": 123,
            "exchangeRate": 123,
            "id": 123,
            "payoutEnable": 123,
            "rechargeEnable": 123,
            "totalDecrementAmount": 123,
            "totalIncrementAmount": 123,
            "type": 123,
            "userId": 123
          },
          "promoCreditDiscountAmount": 123,
          "promoCreditPayout": {
            "creditAmount": 123,
            "currencyAmount": 123,
            "exchangeRate": 123
          },
          "promoCreditTransaction": {
            "accountType": 123,
            "bizId": "<string>",
            "by": "<string>",
            "createTime": 123,
            "creditAmountAfter": 123,
            "creditAmountBefore": 123,
            "creditId": 123,
            "currency": "<string>",
            "deltaAmount": 123,
            "deltaCurrencyAmount": 123,
            "description": "<string>",
            "exchangeRate": 123,
            "id": 123,
            "invoiceId": "<string>",
            "merchantId": 123,
            "name": "<string>",
            "transactionId": "<string>",
            "transactionType": 123,
            "userId": 123
          },
          "prorationDate": 123,
          "prorationScale": 123,
          "refundId": "<string>",
          "sendNote": "<string>",
          "sendStatus": 123,
          "status": 123,
          "subscriptionAmount": 123,
          "subscriptionAmountExcludingTax": 123,
          "subscriptionId": "<string>",
          "taxAmount": 123,
          "taxPercentage": 123,
          "totalAmount": 123,
          "totalAmountExcludingTax": 123,
          "trialEnd": 123,
          "userId": 123,
          "userMetricChargeForInvoice": {
            "meteredChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": "<any>",
                  "graduatedAmounts": "<any>",
                  "metricId": "<any>",
                  "standardAmount": "<any>",
                  "standardStartValue": "<any>"
                },
                "description": "<string>",
                "lines": [
                  "<any>"
                ],
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ],
            "recurringChargeStats": [
              {
                "CurrentUsedValue": 123,
                "chargePricing": {
                  "chargeType": "<any>",
                  "graduatedAmounts": "<any>",
                  "metricId": "<any>",
                  "standardAmount": "<any>",
                  "standardStartValue": "<any>"
                },
                "description": "<string>",
                "lines": [
                  "<any>"
                ],
                "maxEventId": 123,
                "metricId": 123,
                "minEventId": 123,
                "name": "<string>",
                "totalChargeAmount": 123
              }
            ]
          },
          "vatNumber": "<string>"
        },
        "paidTime": 123,
        "partialCreditPaidAmount": 123,
        "payment": {
          "action": {},
          "authorizeComment": "<string>",
          "authorizeReason": "<string>",
          "authorizeStatus": 123,
          "autoCharge": true,
          "automatic": 123,
          "balanceAmount": 123,
          "billingReason": "<string>",
          "cancelTime": 123,
          "countryCode": "<string>",
          "createTime": 123,
          "cryptoAmount": 123,
          "cryptoCurrency": "<string>",
          "currency": "<string>",
          "externalPaymentId": "<string>",
          "failureReason": "<string>",
          "gasPayer": "<string>",
          "gatewayCurrencyExchange": {
            "exchange_amount": 123,
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          },
          "gatewayId": 123,
          "gatewayPaymentId": "<string>",
          "gatewayPaymentType": "<string>",
          "invoiceId": "<string>",
          "lastError": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "metadata": {},
          "paidTime": 123,
          "paymentAmount": 123,
          "paymentId": "<string>",
          "refundAmount": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "totalAmount": 123,
          "userId": 123
        },
        "paymentId": "<string>",
        "periodEnd": 123,
        "periodStart": 123,
        "planSnapshot": {
          "addons": [
            {
              "addonPlan": {
                "amount": "<any>",
                "bindingAddonIds": "<any>",
                "bindingOnetimeAddonIds": "<any>",
                "cancelAtTrialEnd": "<any>",
                "checkoutUrl": "<any>",
                "createTime": "<any>",
                "currency": "<any>",
                "description": "<any>",
                "disableAutoCharge": "<any>",
                "externalPlanId": "<any>",
                "extraMetricData": "<any>",
                "gasPayer": "<any>",
                "homeUrl": "<any>",
                "id": "<any>",
                "imageUrl": "<any>",
                "internalName": "<any>",
                "intervalCount": "<any>",
                "intervalUnit": "<any>",
                "merchantId": "<any>",
                "metadata": "<any>",
                "metricLimits": "<any>",
                "metricMeteredCharge": "<any>",
                "metricRecurringCharge": "<any>",
                "multiCurrencies": "<any>",
                "planName": "<any>",
                "productId": "<any>",
                "publishStatus": "<any>",
                "status": "<any>",
                "taxPercentage": "<any>",
                "trialAmount": "<any>",
                "trialDemand": "<any>",
                "trialDurationTime": "<any>",
                "type": "<any>",
                "usVATConfig": "<any>"
              },
              "quantity": 123
            }
          ],
          "autoCharge": true,
          "chargeType": 123,
          "plan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              "<any>"
            ],
            "metricMeteredCharge": [
              "<any>"
            ],
            "metricRecurringCharge": [
              "<any>"
            ],
            "multiCurrencies": [
              "<any>"
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123,
            "usVATConfig": {}
          },
          "previousAddons": [
            {
              "addonPlan": {
                "amount": "<any>",
                "bindingAddonIds": "<any>",
                "bindingOnetimeAddonIds": "<any>",
                "cancelAtTrialEnd": "<any>",
                "checkoutUrl": "<any>",
                "createTime": "<any>",
                "currency": "<any>",
                "description": "<any>",
                "disableAutoCharge": "<any>",
                "externalPlanId": "<any>",
                "extraMetricData": "<any>",
                "gasPayer": "<any>",
                "homeUrl": "<any>",
                "id": "<any>",
                "imageUrl": "<any>",
                "internalName": "<any>",
                "intervalCount": "<any>",
                "intervalUnit": "<any>",
                "merchantId": "<any>",
                "metadata": "<any>",
                "metricLimits": "<any>",
                "metricMeteredCharge": "<any>",
                "metricRecurringCharge": "<any>",
                "multiCurrencies": "<any>",
                "planName": "<any>",
                "productId": "<any>",
                "publishStatus": "<any>",
                "status": "<any>",
                "taxPercentage": "<any>",
                "trialAmount": "<any>",
                "trialDemand": "<any>",
                "trialDurationTime": "<any>",
                "type": "<any>",
                "usVATConfig": "<any>"
              },
              "quantity": 123
            }
          ],
          "previousPlan": {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              "<any>"
            ],
            "metricMeteredCharge": [
              "<any>"
            ],
            "metricRecurringCharge": [
              "<any>"
            ],
            "multiCurrencies": [
              "<any>"
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123,
            "usVATConfig": {}
          }
        },
        "productName": "<string>",
        "promoCreditDiscountAmount": 123,
        "promoCreditTransaction": {
          "accountType": 123,
          "bizId": "<string>",
          "by": "<string>",
          "createTime": 123,
          "creditAmountAfter": 123,
          "creditAmountBefore": 123,
          "creditId": 123,
          "currency": "<string>",
          "deltaAmount": 123,
          "deltaCurrencyAmount": 123,
          "description": "<string>",
          "exchangeRate": 123,
          "id": 123,
          "invoiceId": "<string>",
          "merchantId": 123,
          "name": "<string>",
          "transactionId": "<string>",
          "transactionType": 123,
          "userId": 123
        },
        "refund": {
          "countryCode": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "externalRefundId": "<string>",
          "gatewayCurrencyExchange": {
            "exchange_amount": 123,
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          },
          "gatewayId": 123,
          "gatewayRefundId": "<string>",
          "invoiceId": "<string>",
          "merchantId": 123,
          "metadata": {},
          "paymentId": "<string>",
          "refundAmount": 123,
          "refundComment": "<string>",
          "refundCommentExplain": "<string>",
          "refundId": "<string>",
          "refundTime": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "type": 123,
          "userId": 123
        },
        "refundId": "<string>",
        "status": 123,
        "subscription": {
          "addonData": "<string>",
          "amount": 123,
          "billingCycleAnchor": 123,
          "cancelAtPeriodEnd": 123,
          "cancelOrExpireTime": 123,
          "cancelReason": "<string>",
          "countryCode": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "currentPeriodEnd": 123,
          "currentPeriodPaid": 123,
          "currentPeriodStart": 123,
          "defaultPaymentMethodId": "<string>",
          "dunningTime": 123,
          "externalSubscriptionId": "<string>",
          "features": "<string>",
          "firstPaidTime": 123,
          "gasPayer": "<string>",
          "gatewayId": 123,
          "gatewayStatus": "<string>",
          "id": 123,
          "lastUpdateTime": 123,
          "latestInvoiceId": "<string>",
          "link": "<string>",
          "merchantId": 123,
          "metadata": {},
          "originalPeriodEnd": 123,
          "pendingUpdateId": "<string>",
          "planId": 123,
          "productId": 123,
          "quantity": 123,
          "returnUrl": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "taskTime": "<string>",
          "taxPercentage": 123,
          "testClock": 123,
          "trialEnd": 123,
          "type": 123,
          "userId": 123,
          "vatNumber": "<string>"
        },
        "subscriptionAmount": 123,
        "subscriptionAmountExcludingTax": 123,
        "subscriptionId": "<string>",
        "taxAmount": 123,
        "taxPercentage": 123,
        "totalAmount": 123,
        "totalAmountExcludingTax": 123,
        "userId": 123,
        "userSnapshot": {
          "address": "<string>",
          "avatarUrl": "<string>",
          "billingType": 123,
          "birthday": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>",
          "createTime": 123,
          "custom": "<string>",
          "email": "<string>",
          "externalUserId": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "gatewayId": 123,
          "gatewayPaymentType": "<string>",
          "gender": "<string>",
          "id": 123,
          "isRisk": 123,
          "isSpecial": 123,
          "language": "<string>",
          "lastLoginAt": 123,
          "lastName": "<string>",
          "linkedIn": "<string>",
          "merchantId": 123,
          "metadata": {},
          "mobile": "<string>",
          "otherSocialInfo": "<string>",
          "paymentMethod": "<string>",
          "phone": "<string>",
          "recurringAmount": 123,
          "registrationNumber": "<string>",
          "school": "<string>",
          "state": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "subscriptionName": "<string>",
          "subscriptionStatus": 123,
          "taxPercentage": 123,
          "telegram": "<string>",
          "tikTok": "<string>",
          "timeZone": "<string>",
          "type": 123,
          "userName": "<string>",
          "vATNumber": "<string>",
          "version": 123,
          "weChat": "<string>",
          "whatsAPP": "<string>",
          "zipCode": "<string>"
        },
        "vatNumber": "<string>"
      }
    ],
    "total": 123
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Bulk credit note invoice list

count
integer

Count By Page

createTimeEnd
integer

CreateTimeEnd,UTC timestamp,seconds

createTimeStart
integer

CreateTimeStart,UTC timestamp,seconds

currency
string<string>

The currency of invoice

emails
string<string>

The email list of invoice user, split by commas or semicolons

file
file

Email CSV File To Search

gatewayIds
integer[]

GatewayIds, Search Filter GatewayIds

page
integer

Page, Start 0

planIds
integer[]

PlanIds, Search Filter PlanIds

searchKey
string<string>

The search key of invoice

sortField
string<string>

Filter,em. invoice_id|gmt_create|gmt_modify|period_end|total_amount,Default gmt_modify

sortType
string<string>

Sort,asc|desc,Default desc

status
integer[]

The status of invoice, 2-processing|3-paid | 4-failed | 5-cancelled

Response

200 - application/json
code
integer
data
object
message
string<string>
redirect
string<string>
requestId
string<string>