Skip to content

SubscriptionsApi.md

Latest commit

 

History

History
174 lines (122 loc) · 5.86 KB

SubscriptionsApi.md

File metadata and controls

174 lines (122 loc) · 5.86 KB

Flipdish\Client\SubscriptionsApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
getSubscriptionById GET /api/v1.0/{appId}/subscriptions/{subscriptionId}
getSubscriptionsForApp GET /api/v1.0/{appId}/subscriptions
hasCustomerGotPaymentMethodOnFile GET /api/v1.0/{appId}/subscriptions/hasPaymentMethod

getSubscriptionById

\Flipdish\Client\Models\RestApiResultSubscription getSubscriptionById($app_id, $subscription_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\SubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$subscription_id = "subscription_id_example"; // string | 

try {
    $result = $apiInstance->getSubscriptionById($app_id, $subscription_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->getSubscriptionById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
subscription_id string

Return type

\Flipdish\Client\Models\RestApiResultSubscription

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSubscriptionsForApp

\Flipdish\Client\Models\RestApiArrayResultSubscriptionSummary getSubscriptionsForApp($app_id, $exclude_not_owned_subscriptions, $store_id, $exclude_cancelled_subscriptions)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\SubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$exclude_not_owned_subscriptions = true; // bool | 
$store_id = array(56); // int[] | 
$exclude_cancelled_subscriptions = true; // bool | 

try {
    $result = $apiInstance->getSubscriptionsForApp($app_id, $exclude_not_owned_subscriptions, $store_id, $exclude_cancelled_subscriptions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->getSubscriptionsForApp: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
exclude_not_owned_subscriptions bool [optional]
store_id int[] [optional]
exclude_cancelled_subscriptions bool [optional]

Return type

\Flipdish\Client\Models\RestApiArrayResultSubscriptionSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hasCustomerGotPaymentMethodOnFile

\Flipdish\Client\Models\RestApiResultHasPaymentMethodResponse hasCustomerGotPaymentMethodOnFile($app_id, $email)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\SubscriptionsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$app_id = "app_id_example"; // string | 
$email = "email_example"; // string | 

try {
    $result = $apiInstance->hasCustomerGotPaymentMethodOnFile($app_id, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsApi->hasCustomerGotPaymentMethodOnFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
email string [optional]

Return type

\Flipdish\Client\Models\RestApiResultHasPaymentMethodResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]