Skip to main content

Documentation

Retrieve Subscription Item

Retrieve the details of a subscription item.

    • subscription_item

    • ID of the subscription item. String starting with subi_.

Code Samples
    • .NET

      • using System;
        using System.Text.Json;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
        
                        string subscriptionItem = "subi_e5dbbf84c68e5bb7db761625158d4262";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/subscription_items/{subscriptionItem}");
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const result = await makeRequest(
              'GET',
              '/v1/subscription_items/subi_e5dbbf84c68e5bb7db761625158d4262'
            );
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
    • PHP

      • <?php
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        include($path);
        
        try {
            $object = make_request('get', '/v1/subscription_items/subi_e5dbbf84c68e5bb7db761625158d4262');
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from utilities import make_request
        
        result = make_request(method='get', path='/v1/subscription_items/subi_e5dbbf84c68e5bb7db761625158d4262')
        pprint(result)
  • /v1/subscription_items/:subscription_item

  • Retrieve Subscription Item

  • curl -X get 'https://sandboxapi.rapyd.net/v1/subscription_items/subi_e5dbbf84c68e5bb7db761625158d4262' \
    -H 'access_key: your-access-key-here' \
    -H 'Content-Type: application/json' \
    -H 'salt: your-random-string-here' \
    -H 'signature: your-calculated-signature-here' \
    -H 'timestamp: your-unix-timestamp-here'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1143b89c-8167-4ad1-a85a-4730fd2c18ba"
        },
        "data": {
            "id": "subi_56de709f3fc6f32c5db71d6c03611841",
            "created": 1763462590,
            "metadata": null,
            "quantity": 1,
            "subscription_id": "sub_423cac7708b84939baf3d4a55b153a19",
            "plan": {
                "id": "plan_88b79142c283f660e6f42b6dbf4c4771",
                "aggregate_usage": "sum",
                "amount": 19.99,
                "billing_scheme": "per_unit",
                "created_at": 1763462581,
                "currency": "USD",
                "interval": "month",
                "interval_count": 1,
                "metadata": {},
                "product": {
                    "id": "product_4ba001c7655c4a0ee4f471dbaccaa305",
                    "active": true,
                    "attributes": [
                        "location",
                        "size"
                    ],
                    "created_at": 1673932995,
                    "description": "Unlimited music streaming",
                    "images": [
                        "64bit-encoded-image-1",
                        "64bit-encoded-image-2"
                    ],
                    "metadata": {},
                    "name": "Unlimited Music",
                    "package_dimensions": {
                        "height": 0,
                        "length": 0,
                        "weight": 0,
                        "width": 0
                    },
                    "shippable": false,
                    "skus": [],
                    "statement_descriptor": "Music streaming",
                    "type": "services",
                    "unit_label": "month",
                    "updated_at": 1673932995
                },
                "nickname": "Unlimited Plan",
                "tiers": [],
                "tiers_mode": "",
                "transform_usage": {
                    "divide_by": 1,
                    "round": "up"
                },
                "trial_period_days": 0,
                "usage_type": "licensed",
                "active": true
            }
        }
    }