Skip to content

Create Subscriptions

This guide provides step-by-step instructions for creating subscriptions for APIs.

A subscription gives a consumer access to an API. A rate plan sets pricing and transaction limits for that access.

When you create a subscription from Manage Subscriptions, you choose the rate plan at create time and also set an application name and environment. Consumers can request access by creating an application as well.

Create Subscription

Step 1: Open Create Subscription

  • Go to Manage Subscriptions.
  • Open the Provider View tab.
  • Click Create Subscription.

Step 2: Fill in Consumer Info

  • Choose Consumer level:
    • Organisation — subscription for an organization.
    • Individual User — subscription for a single user.
  • If you chose Organisation:
    • Choose Organization Level: Internal or API Partner.
    • Choose Select Organization.
    • Choose Select User.
  • If you chose Individual User:
    • Choose Select Internal User.

Step 3: Add application details

  • Enter Application name. The name may fill in automatically after you select a user; you can change it.
  • Choose Select Environment.
  • Under Attach to, choose:
    • API — access to one or more individual APIs.
    • API Group — access to multiple APIs in a group.
  • Select the Organization (the organization that owns the APIs or API Group).
  • Choose Select APIs or Select API Group.

Step 4: Choose a rate plan

  • After you select APIs or an API Group, each selection shows its name with (click to view rate plan).
  • Below the name, click a rate plan pill (for example, Standard API Plan) to associate it. At least one rate plan must be associated with each selected API or API Group.
  • Click the API or API Group name (click to view rate plan) to view the plan details.
  • If no plans are listed, No Rate plans available is shown. Attach rate plans to that API or API Group from Rate Plans first, then return here.
  • To define your own plan instead, click Create Custom Rate Plans and enter the plan details.
  • If any selected API uses Yappes OAuth, configure Scopes before you create the subscription.
  • To add custom attributes:
    • Click Add Attributes, then enter a Key and Value.
    • To add more attributes, click Add Attributes again and enter another Key and Value. Repeat as needed.

Step 5: Create the subscription

  • Click Create Subscription.

After you create a subscription

Subscriptions you create under Create Subscription already have a rate plan. Open Subscription details with the eye icon to manage the subscription.

If the selected API or API Group requires approval, the subscription may show that it is awaiting approval. After an approver approves it, the subscription is activated and you can use Enable Application, Key and Environment, and related actions below.

If the approval is rejected, create a new subscription.

Enable or disable the application

  • Go to Manage Subscriptions.
  • Click the eye icon to open Subscription details.
  • Under Application Status, turn Enable Application on or off.
  • Confirm Enable Application or Disable Application when prompted.

Edit a custom rate plan

You can edit the plan only if you used Create Custom Rate Plans when creating the subscription.

  • Go to Manage Subscriptions.
  • Click the eye icon to open Subscription details.
  • Click Edit.
  • Update the plan in Edit Custom Rate plan.
  • Click Save Plan.

Stop Subscription

  • Go to Manage Subscriptions.
  • Click the eye icon to open Subscription details.
  • Click Stop Subscription.

Key and Environment

When the subscription is active, use the Key and Environment tab in Subscription details to view subscription keys and select the environment.