Configura il piano tariffario

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

Introduzione

In un piano tariffario, allo sviluppatore viene addebitato un costo per ogni transazione. Per questo tipo di piano, devi fornire ulteriori dettagli, come il modello di addebito e i relativi prezzi.

Se vuoi, puoi specificare un piano freemium per singoli prodotti (anziché per un pacchetto API). Puoi farlo solo per un piano specifico per prodotto.

Quando vengono addebitate le tariffe ricorrenti e i piani in bundle vengono reimpostati?

I piani tariffari possono includere tariffe ricorrenti e bundle di API (piani con fasce di volume e bundle), entrambi con periodi specifici in cui vengono addebitate le tariffe e i piani bundle vengono reimpostati su zero. La tabella seguente descrive quando vengono addebitate le tariffe ricorrenti e vengono reimpostati i conteggi dei set. Se alle app sviluppatore viene impedito di effettuare ulteriori chiamate API perché viene raggiunto un determinato limite di transazioni, in questi casi il conteggio delle chiamate API viene reimpostato su zero e le app possono iniziare di nuovo a effettuare chiamate.

Se il piano ha…	...questo accade
Una tariffa ricorrente diversa da zero impostata su Month (Mese) Un piano Volume banded o di bundle	La reimpostazione della commissione ricorrente e del piano del pacchetto avviene il primo giorno del mese (valore predefinito). Per una ricorrenza mensile in un giorno specifico, crea un piano tariffario utilizzando l'API di gestione e indica il giorno con una proprietà RecurringStartUnit, come descritto in Creazione di piani tariffari utilizzando l'API.
Una commissione ricorrente diversa da zero impostata su Settimana Un piano con fasce di volume o un piano in bundle	La reimpostazione del piano tariffario e della tariffa ricorrente avviene ogni 7 giorni dopo la data di inizio del piano tariffario dello sviluppatore.
Una tariffa ricorrente diversa da zero impostata su Giorno Un piano con fasce di volume o un piano in bundle	La reimpostazione della tariffa ricorrente e del piano del pacchetto avviene ogni X giorni dopo la data di inizio del piano tariffario dello sviluppatore.
Nessuna commissione ricorrente (o una pari a zero) Un piano con fasce di volume o un piano in bundle	I piani in bundle vengono reimpostati in base alla base di aggregazione definita nella tariffa. Ad esempio, se uno sviluppatore avvia un piano tariffario il 19 del mese e la base di aggregazione è ogni mese, l'utilizzo del pacchetto viene reimpostato il 19 di ogni mese. Tieni presente che il giorno del mese potrebbe non essere sempre lo stesso. Ad esempio, se un piano di tariffe inizia il 31 dicembre, la data di reimpostazione diventa il 28 febbraio in un anno non bisestile, poiché febbraio ha solo 28 giorni. Il 28 rimane quindi il giorno di reimpostazione per sempre.

Configurare i piani tariffari utilizzando l'interfaccia utente

Configura i piani delle tariffe, come descritto di seguito.

Configurazione del piano tariffario utilizzando l'API

Configura i dettagli del piano tariffario utilizzando l'API, come descritto nelle sezioni seguenti.

Specificare i dettagli del piano tariffario utilizzando l'API

Specifica i dettagli del piano tariffario quando lo crei. Specifica i dettagli nella proprietà ratePlanDetails all'interno del corpo della richiesta in una chiamata a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. I valori specificati nella proprietà ratePlanDetails dipendono dal modello di fatturazione scelto: tariffa fissa, fasce di volume o pacchetti.

Specificare un modello di ricarica a costo fisso

Per implementare il modello di addebito a tariffa fissa, specifica quanto segue nei dettagli del piano tariffario:

• Un parametro di classificazione che indica che il piano tariffario si basa sulle transazioni (VOLUME) o su un attributo personalizzato (ad esempio MINT_CUSTOM_ATTRIBUTE_1). VOLUME è il valore predefinito.
• Un tipo di misurazione (UNIT) che indica che la tariffa è fissa per unità (ovvero non si basa sul volume delle transazioni, come nel caso del modello di fatturazione a fasce di volume o dei pacchetti).
• Il periodo di scadenza del pagamento (ad es. 30 giorni).
• L'ID della tua organizzazione.
• La valuta "di base" o contabile utilizzata dalla tua azienda.
• Una tariffa del piano tariffario che fornisce dettagli su come viene calcolata. Poiché il modello di addebito si basa su una tariffa fissa, devi specificare una sola tariffa del piano tariffario.

Nella tariffa del piano tariffario, specifica:

• Il tipo di tariffa del piano tariffario (RATECARD).
• La tariffa del piano. Ad esempio, se specifichi 0,10 e la valuta è in dollari statunitensi, allo sviluppatore vengono addebitati 0,10 $per ogni transazione (o se si basa su un attributo personalizzato come il numero di byte trasmessi in una transazione, allo sviluppatore vengono addebitati 0,10 $per la trasmissione del numero di byte specificato).
• L'unità iniziale dell'applicazione della tariffa (0). Ciò significa che la tariffa viene applicata a ogni transazione, a partire dalla prima.

Consulta Impostazioni di configurazione dei dettagli del piano tariffario per un elenco completo delle opzioni di dettaglio del piano tariffario.

Ad esempio, il seguente crea un piano tariffario con un modello di addebito fisso. La tariffa è impostata su 0,10 $per ogni transazione. Il pagamento deve essere effettuato entro 30 giorni. I dettagli relativi al tariffario sono evidenziati.

curl -H "Content-Type:application/json" -X POST -d \
'{ 
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     "currency": {
      "id" : "usd"
     },     
     "description": "Flat rate card plan",
     "displayName" : "Flat rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",     
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "paymentDueDays": "30",      
      "meteringType": "UNIT",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
       {
        "type": "RATECARD",
        "rate": "0.10",
        "startUnit": "0"       
       }      
      ], 
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Specifica di un modello di ricarica con fasce di volume

In un modello a bande di volume, specifichi i dettagli del piano tariffario che includono una o più tariffe del piano tariffario. Ogni tariffa si applica a una "banda di volume", ovvero a un intervallo di volume delle transazioni (o a un intervallo basato su un attributo personalizzato come il numero di byte trasmessi). Questo tipo di piano viene solitamente configurato per incoraggiare gli sviluppatori a generare volumi più elevati offrendo tariffe scontate per fasce di volume più alte.

Oltre alle tariffe del piano tariffario, nei dettagli del piano tariffario devi specificare quanto segue:

• Un parametro di classificazione che indica che il piano tariffario si basa sulle transazioni (VOLUME) o su un attributo personalizzato (ad esempio CUSTOM_ATTRIBUTE_1). VOLUME è il valore predefinito.
• Un tipo di misurazione (VOLUME) che indica che la tariffa si basa sul volume delle transazioni (ovvero non è una tariffa fissa per transazione, come nel caso del modello di addebito a tariffa fissa).
• Il periodo di pagamento dovuto (ad esempio 30 giorni).
• L'ID della tua organizzazione.
• La "valuta di base" o contabile utilizzata dall'azienda.
• Un tipo di durata e durata che insieme specificano il periodo di tempo durante il quale viene aggregato il volume di transazioni (o il volume correlato agli attributi personalizzati). Questo viene anche definito "base di aggregazione". Il volume delle transazioni viene aggregato sulla base di aggregazione (ad esempio 1 mese) per determinare la banda di volume applicabile.
• Contatori di aggregazione utilizzati per determinare la fascia di volume applicabile.

Per ogni tariffa del piano tariffario, specifica:

• Il tipo di tariffa del piano tariffario (RATECARD).
• La tariffa del piano. Ad esempio, se specifichi 0,10 e la valuta è in dollari statunitensi, allo sviluppatore vengono addebitati 0,15 $per ogni transazione (oppure, se in base a un attributo personalizzato come il numero di byte trasmessi in una transazione, allo sviluppatore vengono addebitati 0,15 $per la trasmissione del numero specificato di byte).
• L'unità iniziale e finale della banda di volume. L'unità iniziale specifica il limite inferiore della fascia di volume, mentre l'unità finale specifica il limite superiore della fascia di volume. Ad esempio, se specifichi un'unità iniziale pari a 0 e un'unità finale pari a 1000, la fascia di volume copre fino a 1000 transazioni nel periodo di aggregazione. Se la valuta è in dollari statunitensi, il periodo di aggregazione è di 1 mese e l'aliquota per le prime 1000 transazioni è 0,15, allo sviluppatore vengono addebitati 0,15 $per transazione per un massimo di 1000 transazioni al mese.
  
  Per informazioni dettagliate su quando vengono reimpostati i cofanetti, vedi Quando vengono addebitate le commissioni ricorrenti e reimpostati i piani dei cofanetti?
  

  Se non specifichi un'unità finale per la fascia di volume finale, la tariffa per la fascia viene applicata a tutte le transazioni dopo che il numero di transazioni ha superato l'unità iniziale per la fascia. Ad esempio, se l'unità iniziale per l'ultima banda è 1000 e non specifichi un'unità finale per quella banda, la tariffa per la banda viene applicata a tutte le transazioni dopo 1000 transazioni nel periodo di aggregazione.

Consulta Impostazioni di configurazione dei dettagli del piano tariffario per un elenco completo delle opzioni di dettaglio del piano tariffario.

Ad esempio, di seguito viene creato un piano tariffario con un modello di ricarica a bande del volume. La commissione è impostata su 0,15 $per le prime 1000 transazioni e su 0,10 $per tutte le transazioni superiori a 1000. La base di aggregazione è di 1 mese. Il pagamento deve essere effettuato entro 30 giorni. I dettagli del tariffario sono evidenziati.

curl -H "Content-Type:application/json" -X POST -d \

'{
     "name": "Volume banded rate card plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },     
     "frequencyDuration": "30",
     "description": "Volume banded rate card plan",
     "displayName" : "Volume banded rate card plan",
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },      
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "0.15",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "0.10",
       "startUnit": "1000"      
      }
      ],     
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Specifica di un modello di ricarica in bundle

In un modello di addebito in bundle, lo sviluppatore paga (in anticipo) un "pacchetto" di transazioni (o per un bundle in base a un attributo personalizzato come il numero di byte trasmessi). Devi specificare un'aliquota per ogni bundle e una base di aggregazione, ovvero un periodo di tempo in cui lo sviluppatore può utilizzare il bundle.

Ad esempio, supponiamo di configurare due set, in cui il primo set ha una dimensione da 1 a 1000 transazioni e un secondo set ha una dimensione da 1001 a 2000 transazioni. La tariffa è di 50 $per il primo pacchetto e di 40 $per il secondo pacchetto e la base di aggregazione è 1. Se lo sviluppatore acquista un piano tariffario per il primo pacchetto, pagherà 50 $ (anticipati) per 1000 transazioni al mese. Lo sviluppatore viene addebitato l'importo impostato indipendentemente dal fatto che il pacchetto venga utilizzato o meno. Al termine del periodo di aggregazione, il piano scade. Se lo sviluppatore vuole utilizzare di nuovo il pacchetto, deve acquistare di nuovo il piano (e il pacchetto).

Quelle specificate nei dettagli del piano tariffario sono essenzialmente le stesse specificate nei dettagli del piano tariffario per il modello di ricarica con bande del volume. Le differenze sono le seguenti:

• Ogni piano tariffario specificato è per un pacchetto (anziché per una fascia di volume).
• Devi specificare un limite superiore per l'ultimo pacchetto, a meno che tu non voglia addebitare allo sviluppatore un importo fisso per transazioni illimitate nell'ultimo pacchetto.

Consulta Impostazioni di configurazione dei dettagli del piano tariffario per un elenco completo delle opzioni di dettaglio del piano tariffario.

Ad esempio, il seguente crea un piano tariffario con un modello di addebito combinato. La tariffa è impostata su 50 $per il primo pacchetto (fino a 1000 transazioni) e di 40 $per il secondo pacchetto (più di 1000 e fino a 2000 transazioni). La base di aggregazione è di 1 mese. Il pagamento deve essere effettuato entro 30 giorni.

curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Bundled rate plan",
     "developer":null,
     "developerCategory":null,
     "currency": {
      "id" : "usd"
     },    
     "frequencyDuration": "30",
     "description": "Bundled rate plan",
     "displayName" : "Bundled rate plan",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },    
     "paymentDueDays": "30",
     "prorate": "true",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id" : "usd"
      },
      "aggregateStandardCounters": true,
      "paymentDueDays": "30",
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "STAIR_STEP",
      "organization": {
       "id": "{org_name}"
      },
      "ratePlanRates": [
      {
       "type": "RATECARD",
       "rate": "50",
       "startUnit": "0",
       "endUnit": "1000"
      },
      {
       "type": "RATECARD",
       "rate": "40",
       "startUnit": "1000",
       "endUnit": "2000"
      }
      ],
     "ratingParameter": "VOLUME",
     "type": "RATECARD"
     }],
     "recurringStartUnit": 1,
     "recurringType": "CALENDAR",
     "recurringFee": "10",
     "setUpFee": "10",
     "startDate": "2013-09-15 00:00:00",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Specificare un piano freemium per singoli prodotti utilizzando l'API

In un piano tariffario, puoi impostare un piano freemium per un singolo prodotto (anziché un pacchetto API). Un piano freemium offre agli sviluppatori l'utilizzo senza costi di un prodotto API per un determinato periodo di tempo o in base alla quantità di utilizzo.

Quando configuri un piano freemium per un prodotto API, specifica nei dettagli del piano tariffario il periodo in cui lo sviluppatore può utilizzare senza costi le risorse fornite dal prodotto API. Il periodo può essere basato su uno dei seguenti elementi:

• Durata, ovvero il periodo di tempo compreso tra una data di inizio e una di fine.
• Quantità, ad esempio il numero di transazioni che coinvolgono il prodotto dell'API o il volume relativo a un attributo personalizzato registrato nelle norme di registrazione delle transazioni.

Se il periodo di prova è basato sulla quantità, specificalo come numero di unità di prova. Ad esempio, il seguente crea un piano tariffario con un piano freemium basato su un volume di 5000 unità (le specifiche relative al freemium sono evidenziate).

curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "Flat rate card plan with freemium period",
      "developer":null,
      "developerCategory":null,      
      "advance": "false",
      "currency": {
       "id" : "usd"
      },     
      "description": "Flat rate card plan with freemium period",
      "displayName" : "Flat rate card plan with freemium period",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",     
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "myorg"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
       "aggregateFreemiumCounters" : true,
       "aggregateStandardCounters" : true,
        "id" : "usd"
       },
       "product" : {
        "id" : "location",
        "displayName":"Location"
       },
       "paymentDueDays": "30",      
       "meteringType": "UNIT",
       "organization": {
        "id": "myorg"
       },
       "ratePlanRates": [
        {
         "type": "RATECARD",
         "rate": "0.10",
         "startUnit": "0"       
        }      
       ],
      "freemiumUnit": "5000",
      "freemiumDuration": "0",
      "freemiumDurationType": "DAY",
      "ratingParameterUnit":"MB",
      "customPaymentTerm": "false",
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password