Gestisci i saldi prepagati degli account

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X.
Informazioni

Per gestire il saldo in un account prepagato, puoi:

Come faccio a calcolare il saldo prepagato residuo dell'account?

Quando visualizzi il saldo prepagato dell'account di uno sviluppatore o di una società, come descritto nelle sezioni seguenti, devi: ottiene i seguenti valori dalla risposta:

  • amount: importo totale di denaro disponibile per il periodo di fatturazione corrente. Questo valore viene aggiornato quando ricarichi l'account prepagato utilizzando i metodi descritti in questa sezione.
  • usage: importo totale di denaro utilizzato durante il periodo di fatturazione corrente. Questo valore viene aggiornato ogni volta che viene monetizzato transazione o emettendo un credito (positivo o negativo).

Puoi calcolare il saldo prepagato rimanente dell'account per il periodo di fatturazione corrente sottraendo il valore usage dal Valore amount. Ad esempio, se il valore amount è 335,50 e il valore usage è 34, il saldo restante viene calcolato come segue:

amount(335.50) - usage(34) = 229.50

Visualizzare i saldi prepagati degli account utilizzando l'API

Le seguenti sezioni descrivono come visualizzare i saldi prepagati degli account per uno sviluppatore o che utilizza l'API.

Visualizzare i saldi prepagati degli account di uno sviluppatore

Per visualizzare i saldi prepagati degli account di uno sviluppatore, invia una richiesta GET a una delle seguenti API, dove {developer_id} è l'indirizzo email dello sviluppatore:

  • /mint/organizations/{org_name}/developers/{developer_id}/developer-balances: restituisce il saldo prepagato dell'account e le informazioni di configurazione ricorrenti per uno sviluppatore.
  • /mint/organizations/{org_name}/developers/{developer_id}/prepaid-developer-balances: restituisce i dati del saldo prepagato dell'account, tra cui saldo corrente e totale, utilizzo, ricariche e imposte sull'utilizzo.

Puoi passare i seguenti parametri di query per filtrare i risultati:

Parametro di ricerca Descrizione
all Flag che specifica se restituire tutti i pacchetti API. Se il valore è impostato su false, il numero di pacchetti API restituiti per pagina è definita dal parametro di query size. Il valore predefinito è false.
size Numero di pacchetti API restituiti per pagina. Il valore predefinito è 20. Se la query all è impostato su true, questo parametro viene ignorato.
page Numero della pagina da restituire (se i contenuti sono impaginati). Se il parametro di query all è impostato su true, questo viene ignorato.
currencyId ID della valuta per la quale vuoi visualizzare i saldi prepagati dell'account.

Ad esempio:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/{developer_id}/developer-balances" \
-u email:password

Di seguito viene fornito un esempio della risposta:

{
    "developerBalance": [
        {
            "amount": 2005,
            "chargePerUsage": false,
            "id": "your-provider-id",
            "isRecurring": false,
            "supportedCurrency": {
                "description": "United States Dollars",
                "displayName": "United States Dollars",
                "id": "usd",
                "name": "USD",
                "organization": {
                    "address": [
                        {
                            "address1": "10 Almaden Blvd.",
                            "city": "San Jose",
                            "country": "US",
                            "id": "32e808d8-3a3c-4d76-a0ae-17d70a982c61",
                            "isPrimary": true,
                            "state": "CA",
                            "zip": "95113"
                        }
                    ],
                    "approveTrusted": false,
                    "approveUntrusted": false,
                    "billingCycle": "CALENDAR_MONTH",
                    "country": "US",
                    "currency": "USD",
                    "description": "my-org",
                    "groupOrganization": false,
                    "hasBillingAdjustment": false,
                    "hasBroker": false,
                    "hasSelfBilling": false,
                    "hasSeparateInvoiceForProduct": false,
                    "id": "my-org",
                    "issueNettingStmt": false,
                    "name": "my-org",
                    "nettingStmtPerCurrency": false,
                    "selfBillingAsExchOrg": false,
                    "selfBillingForAllDev": false,
                    "separateInvoiceForFees": false,
                    "status": "ACTIVE",
                    "supportedBillingType": "BOTH",
                    "taxModel": "HYBRID",
                    "timezone": "UTC"
                },
                "status": "ACTIVE",
                "virtualCurrency": false
            },
            "usage": 2.1572
        }
    ],
    "totalRecords": 1
}

Visualizzare i saldi prepagati degli account di un'azienda

Per visualizzare i saldi prepagati degli account di un'azienda, invia una richiesta GET a /mint/organizations/{org_name}/companies/{company_id}/developer-balances, dove {company_id} è l'ID dell'azienda. Se l'azienda è prepagata, la richiesta recupera il saldo prepagato dell'account corrente. Se l'azienda ha un pagamento posticipato, la richiesta recupera il massimale di credito attuale.

Puoi passare i seguenti parametri di query per filtrare i risultati:

Parametro di ricerca Descrizione
all Flag che specifica se restituire tutti i pacchetti API. Se il valore è impostato su false, il numero di pacchetti API restituiti per pagina è definita dal parametro di query size. Il valore predefinito è false.
size Numero di pacchetti API restituiti per pagina. Il valore predefinito è 20. Se la query all è impostato su true, questo parametro viene ignorato.
page Numero della pagina da restituire (se i contenuti sono impaginati). Se il parametro di query all è impostato su true, questo viene ignorato.
currencyId ID della valuta per la quale vuoi visualizzare i saldi prepagati dell'account.

Ad esempio:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/{company_id}/developer-balances" \
-u email:password

La risposta è simile alla risposta mostrata sopra, quando si visualizzano i saldi prepagati dell'account per uno sviluppatore.