SubscriptionCreateParameters interface
Details van het maken van abonnementen.
Eigenschappen
allow |
Bepaalt of tracering kan worden ingeschakeld |
display |
Abonnementsnaam. |
owner |
Gebruiker (gebruikers-id-pad) voor wie een abonnement wordt gemaakt in de vorm /users/{userId} |
primary |
Primaire abonnementssleutel. Als deze niet wordt opgegeven tijdens de aanvraag, wordt de sleutel automatisch gegenereerd. |
scope | Bereik zoals /products/{productId} of /apis of /apis/{apiId}. |
secondary |
Secundaire abonnementssleutel. Als deze niet wordt opgegeven tijdens de aanvraag, wordt de sleutel automatisch gegenereerd. |
state | Oorspronkelijke abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of geweigerd, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd. |
Eigenschapdetails
allowTracing
Bepaalt of tracering kan worden ingeschakeld
allowTracing?: boolean
Waarde van eigenschap
boolean
displayName
Abonnementsnaam.
displayName?: string
Waarde van eigenschap
string
ownerId
Gebruiker (gebruikers-id-pad) voor wie een abonnement wordt gemaakt in de vorm /users/{userId}
ownerId?: string
Waarde van eigenschap
string
primaryKey
Primaire abonnementssleutel. Als deze niet wordt opgegeven tijdens de aanvraag, wordt de sleutel automatisch gegenereerd.
primaryKey?: string
Waarde van eigenschap
string
scope
Bereik zoals /products/{productId} of /apis of /apis/{apiId}.
scope?: string
Waarde van eigenschap
string
secondaryKey
Secundaire abonnementssleutel. Als deze niet wordt opgegeven tijdens de aanvraag, wordt de sleutel automatisch gegenereerd.
secondaryKey?: string
Waarde van eigenschap
string
state
Oorspronkelijke abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of geweigerd, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.
state?: SubscriptionState