SubscriptionUpdateParameters interface
Podrobnosti o aktualizaci předplatného
Vlastnosti
allow |
Určuje, jestli je možné povolit trasování. |
display |
Název předplatného |
expiration |
Datum vypršení platnosti předplatného Nastavení je určené jenom pro účely auditu a předplatné nevypršelo automaticky. Životní cyklus předplatného je možné spravovat pomocí vlastnosti |
owner |
Cesta identifikátoru uživatele: /users/{userId} |
primary |
Primární klíč předplatného. |
scope | Rozsah jako /products/{productId} nebo /apis nebo /apis/{apiId} |
secondary |
Sekundární klíč předplatného. |
state | Stav předplatného Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. |
state |
Komentáře popisující změnu stavu předplatného správcem při změně stavu na "odmítnuto". |
Podrobnosti vlastnosti
allowTracing
Určuje, jestli je možné povolit trasování.
allowTracing?: boolean
Hodnota vlastnosti
boolean
displayName
Název předplatného
displayName?: string
Hodnota vlastnosti
string
expirationDate
Datum vypršení platnosti předplatného Nastavení je určené jenom pro účely auditu a předplatné nevypršelo automaticky. Životní cyklus předplatného je možné spravovat pomocí vlastnosti state
. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ
podle normy ISO 8601.
expirationDate?: Date
Hodnota vlastnosti
Date
ownerId
Cesta identifikátoru uživatele: /users/{userId}
ownerId?: string
Hodnota vlastnosti
string
primaryKey
Primární klíč předplatného.
primaryKey?: string
Hodnota vlastnosti
string
scope
Rozsah jako /products/{productId} nebo /apis nebo /apis/{apiId}
scope?: string
Hodnota vlastnosti
string
secondaryKey
Sekundární klíč předplatného.
secondaryKey?: string
Hodnota vlastnosti
string
state
Stav předplatného Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu, * odeslat – žádost o předplatné odeslal vývojář, ale ještě nebyla schválena nebo odmítnuta, * odmítnuta – žádost o předplatné byl zamítnut správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela platnost – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.
state?: SubscriptionState
Hodnota vlastnosti
stateComment
Komentáře popisující změnu stavu předplatného správcem při změně stavu na "odmítnuto".
stateComment?: string
Hodnota vlastnosti
string