Skonfiguruj plan arkusza stawek

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

W planie arkusza stawek deweloper jest obciążany za każdą transakcję. W przypadku tego typu planu musisz podać dodatkowe informacje, takie jak model opłat i ceny.

Opcjonalnie możesz określić pakiet freemium dla poszczególnych usług (a nie dla pakietu interfejsu API). Możesz to zrobić tylko w przypadku pakietu konkretnej usługi.

Kiedy są naliczane opłaty cykliczne i resetowane abonamenty?

Plany cenowe mogą obejmować opłaty cykliczne oraz pakiety interfejsu API (plany objętościowe i pakietowe). Oba te plany obejmują określone momenty, w których naliczane są opłaty, a plany pakietowe są resetowane do zera. W tabeli poniżej opisano, kiedy naliczane są opłaty cykliczne i jakie jest resetowanie liczby pakietów. Jeśli aplikacje dewelopera są zablokowane i nie mogą wykonywać dalszych wywołań interfejsu API, ponieważ osiągnęły określony limit transakcji, to są momenty, w których liczba wywołań interfejsu API jest resetowana do zera, a aplikacje mogą ponownie wykonywać wywołania.

Jeśli abonament obejmuje...	...to się dzieje
cykliczna opłata inna niż zerowa ustawiona na miesiąc. Abonament z objętością lub pakietem woluminowym	Opłata cykliczna i plan pakietu są resetowane pierwszego dnia miesiąca (domyślnie). Aby utworzyć plan stawek z miesięczną częstotliwością w konkretnym dniu, użyj interfejsu API do zarządzania i wskaż dzień za pomocą właściwości RecurringStartUnit, zgodnie z opisem w artykule Tworzenie planów stawek za pomocą interfejsu API.
niezerową opłatę cykliczną ustawioną na Tydzień. Plan z ograniczonym limitem transmisji danych lub pakiet.	Cykliczne opłaty i plany pakietów są resetowane co 7 dni po dacie rozpoczęcia stosowania przez dewelopera stawek.
niezerową opłatę cykliczną ustawioną na Dzień; Plan z ograniczonym limitem transmisji danych lub pakiet.	Resetowanie cyklicznych opłat i planu pakietu odbywa się co X dni po dacie rozpoczęcia stosowania przez dewelopera stawek.
Brak opłaty cyklicznej (lub opłaty w wysokości 0 USD) Abonament z objętością lub pakietem woluminowym	Pakiety są resetowane na podstawie podstawy agregacji zdefiniowanej w karcie cen. Jeśli na przykład deweloper rozpoczyna plan taryfowy 19. dnia miesiąca, a podstawa agregacji to co miesiąc, wykorzystanie pakietu jest resetowane co miesiąc 19. dnia. Pamiętaj, że dzień miesiąca może się różnić. Jeśli na przykład plan stawek rozpoczyna się 31 grudnia, datą resetowania stanie się 28 dnia lutego bez okresu przestępnego, ponieważ w lutym jest tylko 28 dni. 28 dzień pozostaje dniem resetowania.

Konfigurowanie planów w arkuszu stawek za pomocą interfejsu użytkownika

Skonfiguruj plany cenowe zgodnie z opisem poniżej.

Konfigurowanie planu cennika za pomocą interfejsu API

Skonfiguruj szczegóły planu cennika za pomocą interfejsu API zgodnie z opisem w poniższych sekcjach.

Określanie szczegółów planu cennika za pomocą interfejsu API

Szczegóły planu cennika określasz podczas jego tworzenia. Szczegóły podajesz w właściwości ratePlanDetails w treści żądania w wywołaniu funkcji /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Wartość podana we właściwości ratePlanDetails zależy od wybranego modelu ładowania: ze stałą opłatą, w pasmach lub w pakietach.

Określanie modelu opłat ryczałtowych

Aby wdrożyć model opłat według stałej stawki, w szczegółach planu opłat:

• Parametr oceny wskazujący, że plan stawek jest oparty na transakcjach (VOLUME) lub na atrybucie niestandardowym (na przykład MINT_CUSTOM_ATTRIBUTE_1). Wartość domyślna to VOLUME.
• Typ pomiaru (UNIT), który wskazuje, że stawka jest stała na jednostkę (czyli nie jest uzależniona od liczby transakcji, tak jak w przypadku modelu pomiaru ilościowego lub opłat za pakiety).
• termin płatności (np. 30 dni);
• Identyfikator Twojej organizacji.
• „Podstawowa” waluta księgowa, której używa Twoja firma.
• Stawka planu taryfowego, która zawiera szczegółowe informacje o sposobie jej obliczania. Ponieważ model naliczania opłat jest oparty na stałej stawce, musisz określić tylko jedną stawkę.

W ramach stawki planu cenowego określasz:

• Typ stawki planu taryfowego (RATECARD).
• Stawka za plan. Jeśli np. podasz wartość 0,10, a waluta to dolary amerykańskie, deweloperowi zostanie naliczona opłata w wysokości 0,10 USD za każdą transakcję (lub jeśli opłata jest obliczana na podstawie atrybutu niestandardowego, takiego jak liczba bajtów przesłanych w ramach transakcji, deweloperowi zostanie naliczona opłata w wysokości 0,10 USD za przesłanie określonej liczby bajtów).
• Jednostka początkowa stawki (0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej.

Pełną listę opcji szczegółów abonamentu znajdziesz w sekcji Ustawienia konfiguracji szczegółów abonamentu.

Na przykład poniższy kod tworzy plan dotyczący stawek z modelem opłat ryczałtowych. Stawka wynosi 0,10 USD za każdą transakcję. Termin płatności upływa za 30 dni. (wyróżnione są dane związane z arkuszem stawek).

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

Określanie modelu ładowania przy użyciu przepustowości

W modelu z pasmami wolumenu określasz szczegóły planu cenowego, które obejmują co najmniej 1 cenę planu cenowego. Każda cena dotyczy „pasma wolumenu”, czyli zakresu wolumenu transakcji (lub zakresu na podstawie atrybutu niestandardowego, takiego jak liczba przesyłanych bajtów). Ten typ planu jest zwykle ustawiany w celu zachęcenia deweloperów do generowania większych wolumenów poprzez oferowanie zniżek na pasma o większym wolumenie.

Oprócz stawek planu taryfowego w szczegółach planu taryfowego musisz podać:

• Parametr oceny wskazujący, że plan stawek jest oparty na transakcjach (VOLUME) lub na atrybucie niestandardowym (na przykład CUSTOM_ATTRIBUTE_1). Wartość domyślna to VOLUME.
• Typ pomiaru (VOLUME), który wskazuje, że stawka jest ustalana na podstawie liczby transakcji (czyli nie jest to stała stawka za transakcję, jak w przypadku modelu opłat ze stałą stawką).
• Termin płatności (np. 30 dni).
• Identyfikator Twojej organizacji.
• „Podstawowa” lub waluta księgowa używana przez firmę.
• Czas trwania i jego typ, które razem określają okres, w którym jest agregowana liczba transakcji (lub liczba transakcji związanych z atrybutem niestandardowym). Jest to też tzw. „podstawa agregacji”. Liczba transakcji jest agregowana na podstawie agregacji (np. z 1 miesiąca), aby określić odpowiedni zakres wolumenu.
• Liczniki agregacji, które służą do określania odpowiedniego zakresu wolumenu.

W przypadku każdej stawki planu cenowego określasz:

• Typ stawki planu taryfowego (RATECARD).
• Stawka za plan. Jeśli np. podasz wartość 0,10, a waluta to dolary amerykańskie, deweloper zapłaci 0,15 USD za każdą transakcję (lub jeśli opłata jest obliczana na podstawie atrybutu niestandardowego, takiego jak liczba bajtów przesłanych w ramach transakcji, deweloper zapłaci 0,15 USD za przesłanie określonej liczby bajtów).
• Początkowa i końcowa jednostka zakresu głośności. Jednostka początkowa określa dolną granicę przedziału objętości, a jednostka końcowa – górną granicę przedziału objętości. Jeśli na przykład określisz jednostkę początkową 0, a końcową – 1000, zakres wolumenu obejmuje maksymalnie 1000 transakcji w okresie agregacji. Jeśli waluta to dolar amerykański, okres agregacji to 1 miesiąc, a stawka za pierwsze 1000 transakcji wynosi 0,15%, deweloperowi zostanie naliczona opłata w wysokości 0,15 USD za każdą transakcję do 1000 transakcji w danym miesiącu.
  
  Informacje o tym, kiedy pakiety są resetowane, znajdziesz w sekcji Kiedy są naliczane opłaty cykliczne i resetowane abonamenty?
  

  Jeśli nie określisz końcowej jednostki dla ostatniego zakresu objętości, stawka dla tego zakresu będzie stosowana do wszystkich transakcji, gdy liczba transakcji przekroczy jednostkę początkową tego zakresu. Jeśli na przykład jednostka początkowa ostatniego przedziału wynosi 1000, a nie określisz jednostki końcowej dla tego przedziału, stawka dla tego przedziału zostanie zastosowana do wszystkich transakcji po 1000 transakcjach w okresie agregacji.

Pełną listę opcji szczegółów abonamentu znajdziesz w sekcji Ustawienia konfiguracji szczegółów abonamentu.

Na przykład poniższy kod tworzy plan dotyczący stawek z modelem opłat w zakresie objętości. Stała stawka wynosi 0,15 USD za pierwsze 1000 transakcji i 0,10 USD w przypadku wszystkich transakcji powyżej 1000. Podstawa agregacji to 1 miesiąc. Termin płatności upływa za 30 dni. (szczegóły arkusza stawek są wyróżnione)

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

Określanie modelu ładowania w pakiecie

W ramach pakietowego modelu naliczania opłat deweloper płaci (z wyprzedzeniem) za „pakiet” transakcji (lub za pakiet oparty na atrybucie niestandardowym, takim jak liczba przesyłanych bajtów). Określasz stawkę dla każdej grupy oraz podstawę agregacji, czyli okres, w którym deweloper może korzystać z grupy.

Załóżmy na przykład, że masz 2 pakiety: pierwszy o rozmiarze 1–1000 transakcji i drugi o rozmiarze 1001–2000 transakcji. Stawka wynosi 50 USD za pierwszy pakiet i 40 USD za drugi. Podstawa agregacji wynosi 1. Jeśli deweloper kupi plan z taryfą dla pierwszego pakietu, zapłaci 50 USD (z góry) za 1000 transakcji w miesiącu. Deweloper jest obciążany ustaloną kwotą niezależnie od tego, czy pakiet zostanie wykorzystany w całości, czy nie. Po zakończeniu okresu agregacji abonament wygasa. Jeśli deweloper chce ponownie użyć pakietu, będzie musiał jeszcze raz kupić abonament (wraz z pakietem).

Informacje podawane w szczegółach abonamentu są zasadniczo takie same jak w szczegółach abonamentu w ramach modelu opłat według przedziału wolumenu. Różnice są następujące:

• Każdy określony przez Ciebie plan stawek dotyczy pakietu (a nie zakresu objętości).
• Musisz określić górny limit dla ostatniego pakietu, chyba że chcesz naliczać deweloperowi stałą kwotę za nieograniczoną liczbę transakcji w ramach tego pakietu.

Pełną listę opcji szczegółów abonamentu znajdziesz w artykule Ustawienia konfiguracji szczegółów abonamentu.

Na przykład poniższy kod tworzy plan dotyczący stawek z modelem opłat w pakiecie. Stawka wynosi 50 USD za pierwszy pakiet (do 1000 transakcji) i 40 USD za drugi pakiet (powyżej 1000 i do 2000 transakcji). Podstawą agregacji jest 1 miesiąc. Termin płatności upływa za 30 dni.

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

Określanie planu freemium dla poszczególnych produktów za pomocą interfejsu API

W planie cennika możesz skonfigurować wersję freemium dla konkretnej usługi (a nie dla pakietu interfejsu API). Abonament freemium umożliwia deweloperom bezpłatne korzystanie z produktu API przez określony czas lub w zależności od częstotliwości korzystania.

Podczas konfigurowania planu freemium dla produktu API określasz w szczegółach cennika okres, w którym deweloper może bezpłatnie korzystać z zasobów udostępnianych przez produkt API. Okres może być określony na podstawie jednego z tych elementów:

• Czas trwania, czyli czas między datą wejścia w życie a datą zakończenia.
• Ilość, np. liczba transakcji z użyciem produktu interfejsu API lub wolumen dotyczący atrybutu niestandardowego zarejestrowanego w zasadach rejestrowania transakcji.

Jeśli okres bezpłatnego korzystania jest określony na podstawie ilości, określ go jako liczbę jednostek bezpłatnego korzystania. Na przykład poniższy kod tworzy plan dotyczący cen z planem typu freemium opartym na wolumenie 5000 jednostek (specyfikacje dotyczące freemium są wyróżnione).

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