Skip to content

Latest commit

 

History

History
174 lines (125 loc) · 5.52 KB

SubscriptionsApi.md

File metadata and controls

174 lines (125 loc) · 5.52 KB

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

RestApiResultSubscription getSubscriptionById(appId, subscriptionId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SubscriptionsApi apiInstance = new SubscriptionsApi();
String appId = "appId_example"; // String | 
String subscriptionId = "subscriptionId_example"; // String | 
try {
    RestApiResultSubscription result = apiInstance.getSubscriptionById(appId, subscriptionId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#getSubscriptionById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
subscriptionId String

Return type

RestApiResultSubscription

Authorization

oauth2

HTTP request headers

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

getSubscriptionsForApp

RestApiArrayResultSubscriptionSummary getSubscriptionsForApp(appId, excludeNotOwnedSubscriptions, storeId, excludeCancelledSubscriptions)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SubscriptionsApi apiInstance = new SubscriptionsApi();
String appId = "appId_example"; // String | 
Boolean excludeNotOwnedSubscriptions = true; // Boolean | 
List<Integer> storeId = Arrays.asList(56); // List<Integer> | 
Boolean excludeCancelledSubscriptions = true; // Boolean | 
try {
    RestApiArrayResultSubscriptionSummary result = apiInstance.getSubscriptionsForApp(appId, excludeNotOwnedSubscriptions, storeId, excludeCancelledSubscriptions);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#getSubscriptionsForApp");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
excludeNotOwnedSubscriptions Boolean [optional]
storeId List<Integer> [optional]
excludeCancelledSubscriptions Boolean [optional]

Return type

RestApiArrayResultSubscriptionSummary

Authorization

oauth2

HTTP request headers

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

hasCustomerGotPaymentMethodOnFile

RestApiResultHasPaymentMethodResponse hasCustomerGotPaymentMethodOnFile(appId, email)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.SubscriptionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

SubscriptionsApi apiInstance = new SubscriptionsApi();
String appId = "appId_example"; // String | 
String email = "email_example"; // String | 
try {
    RestApiResultHasPaymentMethodResponse result = apiInstance.hasCustomerGotPaymentMethodOnFile(appId, email);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionsApi#hasCustomerGotPaymentMethodOnFile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
email String [optional]

Return type

RestApiResultHasPaymentMethodResponse

Authorization

oauth2

HTTP request headers

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